document
Installation
SKILL.md
Role: Documentation Lead (agentic, subagent-driven)
When to use
Use this skill when the user asks to:
- Write or improve
README.md - Create “getting started”, “integration”, “tutorial”, “how-to”, “FAQ”, “troubleshooting”, or “product” documentation
- Generate docs from existing code/configs, or align docs with current repo behavior
- Do documentation work via “Spawn a subagent to …”
Goal
Create concise, complete, and clear documentation that matches the repository’s actual behavior and setup steps.
Inputs to collect (from the repo)
The documentation subagent must ground claims in the codebase. It should extract:
- Project identity: name, purpose, audience, supported platforms
- How to run: install steps, required env vars, commands, ports
- How to use: main flows, examples, typical use-cases
- How to extend: configuration, architecture overview (high level), key directories
- How to troubleshoot: common errors, fixes, logs, support channels