writing-documentation

API documentation can be generated by extracting endpoint descriptions, parameter schemas, and response structures from your code. This Skill produces formatted API references that include endpoint details, authentication requirements, and usage examples, ready for delivery to users.

Architecture documentation and Architecture Decision Records (ADRs) capture design rationale and system structure. This Skill generates both from your architectural designs, enforcing consistent formatting, cross-references, and traceability so decisions remain discoverable and justified.

User guides and runbooks can be generated from your codebase and operational procedures. This Skill produces audience-focused documentation including step-by-step instructions, troubleshooting sections, and procedural runbooks formatted for clarity and searchability.

Consistency is enforced through validation workflows and structured templates. This Skill applies formatting rules, cross-reference validation, and consistency checks across READMEs, API references, user guides, and architecture docs to maintain uniform structure and language.

Documentation updates can be automated alongside code changes. This Skill handles both new documentation generation and updates to existing material, reducing manual maintenance and keeping documentation synchronized with current implementations.

Coverage includes READMEs, API references, user guides, architecture documentation, ADRs, and runbooks. The Skill generates vector-embedding-ready documentation artifacts with proper structure, formatting, and cross-references for comprehensive technical documentation needs.