docs

Featured

Audit documentation and developer experience against the live product — drift, onboarding, error messages — and write or fix docs when asked.

AI & Automation 343 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docs Assess by default; write only when the request asks. Documentation is judged by use: a page that cannot be followed is worse than none. The live interface (the real `--help` output, routes, exports) is the truth; every README table, guide, and agent-context file is a claim to check against it. The assessment half is a saved workflow, not a procedure this skill performs inline. Its single source of truth is `.claude/workflows/docs-audit.js` in the genie repository's canonical workflow catalog (see `.claude/workflows/README.md` there); this skill is its front door. On a runtime that runs saved workflows, run the script at `<repository root>/.claude/workflows/docs-audit.js` when that file exists, otherwise `~/.claude/workflows/docs-audit.js` (delivered by `genie install` / `genie update`); give the runtime that explicit script path, never a bare name — both scopes now carry these names and the order a name resolves in is undocumented. Pass `{focus?, surfaces?, quorum?, model?, timestamp?}` — every key optional, and with no `surfaces` list the audit runs the full four-surface roster of the table below. The workflow probes read-only: it asks nothing, writes nothing, and moves no file. Relay the returned `report` unchanged, and list `notConvened` (agents that returned nothing) beside the `unread` (paths no auditor could read) and `unprobed` (documented claims no auditor could probe read-only) lists rather than filling any of the three gaps yourself. ## When to use - Modu...

Details

Author
automagik-dev
Repository
automagik-dev/genie
Created
1 years ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category