Does it support API examples?

Yes, it mandates including working request/response examples, such as curl commands or SDK snippets, for every endpoint to ensure a better developer experience.

Can it help with incident response?

Absolutely. It provides a specific structure for operational runbooks, focusing on step-by-step procedures, expected outcomes, and rollback steps to assist on-call engineers under pressure.

How does it help prevent documentation rot?

It includes instructions for integrating documentation into CI/CD pipelines for validation, setting review cadences, and adding metadata like 'last-updated' dates and ownership to every document.

What types of documentation can this skill create?

This skill is designed to handle API references (REST, GraphQL, gRPC), operational runbooks, onboarding guides, architectural decision logs (ADRs), and standardized changelogs.

Technical Documentation Guide

Name: Technical Documentation Guide
Author: CUBETIQ

byCUBETIQ

•

学習とドキュメンテーション

Creates and maintains professional technical documentation, from API references to operational runbooks and decision logs.

The Technical Documentation skill provides a structured framework for Claude to produce high-quality, production-ready documentation that is accurate, maintainable, and audience-appropriate. It covers a wide range of documentation types, including API references for REST and GraphQL, step-by-step operational runbooks for incident response, progressive onboarding guides for new engineers, and architectural decision logs. By emphasizing active voice, working examples, and CI/CD integration, this skill ensures your documentation remains a reliable single source of truth that evolves alongside your codebase.

主な機能

011 GitHub stars

02Standardized templates for APIs, runbooks, and decision logs

03Progressive disclosure onboarding guides for new team members

04Step-by-step operational runbook structures for incident response

05Integrated patterns for CI/CD documentation validation

06Audience-first writing strategies for tailored technical context

ユースケース

01Creating actionable operational runbooks for devops and maintenance tasks

02Drafting production-grade API documentation with request/response examples

03Maintaining architectural decision logs to track technical trade-offs

主な機能

011 GitHub stars

02Standardized templates for APIs, runbooks, and decision logs

03Progressive disclosure onboarding guides for new team members

04Step-by-step operational runbook structures for incident response

05Integrated patterns for CI/CD documentation validation

06Audience-first writing strategies for tailored technical context

ユースケース

01Creating actionable operational runbooks for devops and maintenance tasks

02Drafting production-grade API documentation with request/response examples

03Maintaining architectural decision logs to track technical trade-offs