Generates production-ready technical documentation including API references, operational runbooks, and onboarding guides using industry best practices.
The tech-doc skill streamlines the creation and maintenance of high-quality technical documentation by providing structured templates and rigorous standards. It guides users through crafting clear API references from a consumer perspective, building actionable incident response runbooks, and establishing progressive onboarding paths for new engineers. By integrating documentation into the development lifecycle and CI/CD pipelines, this skill ensures that project information remains accurate, accessible, and synchronized with the codebase while maintaining a clear audit trail through decision logs and changelogs.
主要功能
011 GitHub stars
02Progressive disclosure onboarding guides designed for rapid engineer ramp-up.
03Actionable step-by-step operational runbooks for incident response and routine procedures.
04Decision log (ADR) and changelog standard enforcement to capture technical context and history.
05Standardized API documentation patterns for REST, GraphQL, and gRPC with working code examples.
06Automated documentation validation strategies for CI/CD pipeline integration.
使用场景
01Automating the creation of comprehensive API references with request/response snippets and error catalogs.
02Establishing a structured architecture decision log to record technical trade-offs and long-term context.
03Writing clear, pressure-tested runbooks for on-call engineering teams to use during incidents.
