Does it follow specific API documentation standards?

The skill emphasizes OpenAPI structures and focuses on the consumer perspective, ensuring documentation includes authentication details, request formats, and error codes.

Can this skill help with existing documentation audits?

Yes, it includes specific instructions for auditing existing documentation for completeness, accuracy, and staleness to ensure content remains relevant.

What types of documentation does the tech-doc skill support?

It supports a wide range of documents including API references (REST/GraphQL/gRPC), operational runbooks, onboarding guides, Architecture Decision Records (ADR), and standardized changelogs.

Is the output compatible with standard developer tools?

The skill generates structured Markdown files, making it compatible with GitHub, GitLab, and various static site generators like Docusaurus or MkDocs.

How does it prevent documentation drift?

It provides guidelines for integrating documentation into CI/CD pipelines, validating links, and establishing review cadences to keep docs in sync with the codebase.

Technical Documentation Expert

Name: Technical Documentation Expert
Author: CUBETIQ

byCUBETIQ

•

Learning & Documentation

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.

Key Features

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.

Use Cases

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.

Key Features

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.

Use Cases

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.