lsantosweb When to use
Use this skill only for explicit documentation work:
- README
- setup docs
- API docs
- ADR
- changelog
- tutorial
- JSDoc/TSDoc/docstrings
Core operating rules
- Prefer short, scannable, useful documentation.
- Optimize for the actual audience.
- Include examples when practical.
- Keep docs aligned with code reality.
- Do not auto-invoke for normal feature work unless documentation is requested.
Recommended structures
README
- one-line summary
- quick start
- features
- configuration
- scripts
- deployment or usage notes
API docs
- endpoint purpose
- request/response examples
- auth behavior
- error cases
Mandatory checks
- examples are consistent with current code
- headings are scannable
- outdated statements are removed