What problem does it solve?
Poor documentation creates onboarding friction, erases architectural rationale, leads to relitigated decisions, and causes public API docs to drift from their source of truth, breaking consumer trust and slowing development velocity.
Core Features & Use Cases
- Enforces README completeness (purpose, install, usage) to eliminate reverse-engineering intent from code for new contributors and autonomous agents.
- Guides separation of technical and user-facing documentation for distinct audiences, ensuring each group finds the information they need without wading through irrelevant content.
- Implements Architecture Decision Record (ADR) discipline with greppable back-references to preserve decision rationale across team turnover and refactors.
- Sets up automated documentation generation pipelines with CI drift checks for public APIs, CLIs, and specs to eliminate hand-maintained, out-of-date reference docs.
- Use Case: For a new polyglot monorepo, use this skill to audit existing documentation gaps, add ADRs for past load-bearing technical choices, and configure CI to auto-generate and validate OpenAPI reference docs against the committed spec.
Quick Start
Use the documentation skill to audit your project's README, ADR coverage, and public API documentation pipeline for gaps against the skill's core principles.
