auto-docs
Installation
SKILL.md
Auto Docs
A protocol for generating and maintaining project documentation from the code. Docs rot because they live apart from the code that defines them. This protocol treats docs as derived: generate them from what is actually there, regenerate the parts that drifted, and skip the parts that maintain themselves.
1. Analyze project structure
Read the project before writing anything.
- Detect project type from manifests (
package.json,pyproject.toml,go.mod,Cargo.toml,pom.xml). - Identify entry points and the public surface: exports, routes, CLI commands, config keys, environment variables.
- Locate existing docs and the install, build, test, and start commands.
Do not document what you have not read. A guessed API reference is worse than none.
2. Generate or update the README
Answer four questions in order: what is this, how do I run it, how do I use it, where do I go next. Use the actual install and usage commands. Update the sections that drifted; leave hand-tuned prose alone.