documentation
Use when creating READMEs, API docs, ADRs, or user guides. Provides templates and patterns for each documentation type. Dispatched by /work for docs-type tasks.
Works with
--- name: documentation description: Use when creating READMEs, API docs, ADRs, or user guides. Provides templates and patterns for each documentation type. Dispatched by /work for docs-type tasks. license: MIT --- # Documentation Create clear, maintainable technical documentation that serves your audience. ## Key Principles - **Documentation as code** — docs live with code, version with code, review with code - **Audience-first writing** — write for who's reading, not what you know - **Maintainability over completeness** — inaccurate docs are worse than no docs - **Link to source of truth** — don't duplicate information across docs ## Quick Start Checklist 1. Identify documentation type (README, API docs, ADR, user guide) 2. Determine audience (all users, developers, team, contributors) 3. Follow type-specific template from references 4. Include working examples (test them!) 5. Link to related documentation ## Documentation Types | Type | When to Use | Audience | |------|-------------|----------| | README | Project entry point | All users | | API Docs | Endpoint reference | Developers | | ADR | Major decisions | Team/future devs | | User Guide | Task completion | End users | ## When NOT to Use - **Inline code comments** — Just add comments directly; this skill is for standalone documentation artifacts - **API design** — Use `api-design` for designing APIs; this skill documents existing APIs ## References | Reference | Description | |-----------|-------------| | [readme-guide.md](references/readme-guide.md) | README templates, section patterns, badges | | [api-docs.md](references/api-docs.md) | API documentation patterns, OpenAPI integration | | [adr-guide.md](references/adr-guide.md) | Architecture Decision Record format and workflow | | [diagrams.md](references/diagrams.md) | Mermaid diagram patterns for common scenarios | | [readme-template.md](references/readme-template.md) | Template for project README files | | [adr-template.md](references/adr-template.md) | Template for Architecture Decision Records |
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
