doc
Installation
SKILL.md
Doc Skill
YOU MUST EXECUTE THIS WORKFLOW. Do not just describe it.
Generate and validate documentation for any project. --mode selects the artifact family — the default mode handles code/API docs and code-maps; --mode=readme generates a gold-standard README; --mode=oss scaffolds and audits the open-source doc pack.
Modes
--mode |
Artifact | Read first |
|---|---|---|
| (default) | API docs, code-maps, doc coverage/validate | this file |
readme |
Gold-standard README (interview → generate → council-validate) | references/readme-craft.md |
oss |
OSS doc pack (CONTRIBUTING/CHANGELOG/AGENTS.md, audit + scaffold) | references/oss-pack.md |
Mode routing (absorbed skills):
| You typed | Runs |
|---|---|
| "readme", "rewrite the README", "validate the README" | /doc --mode=readme [...] |
| "oss docs", "scaffold contributing", "audit OSS docs" | /doc --mode=oss [...] |