document

Generate technical documentation from OpenAPI specs and code annotations.

2|1|Updated Jul 2, 2025

Search Tags:#architecture #documentation #API #onboarding #OpenAPI #ADR #runbooks

Ready to run

npx skills add https://github.com/rikdc/claude_code_template --skill document

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document
Source: https://github.com/rikdc/claude_code_template/tree/main/.claude/skills/document
Command: npx skills add https://github.com/rikdc/claude_code_template --skill document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineering teams create clear, comprehensive technical documentation for software systems, including API docs, architecture decisions, system architecture visuals, developer guides, and runbooks, reducing manual writing time and ensuring consistency.

Core Features & Use Cases

API Documentation: Generate API docs from OpenAPI specs or code annotations, with examples and diagrams.
Architecture & ADRs: Create Architecture Decision Records and system architecture documentation to capture decisions and designs.
Developer Onboarding & Runbooks: Produce onboarding guides and operational runbooks to accelerate team ramp-up and day-to-day operations.

Quick Start

Use the document skill to create a developer onboarding guide for a new microservice, or generate API docs from an OpenAPI spec.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate API documentation from an OpenAPI spec?▼

API documentation can be generated directly from OpenAPI specifications, automatically producing endpoint references, request/response examples, and parameter documentation that stays synchronized with your spec as it evolves.

What's the best way to document architecture decisions in a software project?▼

Architecture Decision Records (ADRs) capture design choices, rationale, and trade-offs in a standardized format. Using ADR templates ensures consistency across your team and creates a queryable history of how your system evolved.

Can I automate developer onboarding documentation for new microservices?▼

Yes. Onboarding guides and system runbooks can be generated to accelerate team ramp-up by automating the creation of setup instructions, common workflows, and operational procedures tied directly to your codebase.

How do I keep architecture documentation in sync with code changes?▼

Documentation that enforces close alignment with code can be maintained by anchoring docs to code annotations, OpenAPI specs, and versioned templates, reducing drift between documentation and implementation.

What documentation should I create for a new software system?▼

Technical documentation typically includes API docs, architecture diagrams, system design decisions (ADRs), developer onboarding guides, and operational runbooks—all essential for team clarity and system maintainability.

Does this work for documenting multiple projects or just single services?▼

Documentation automation applies across projects and architectural scopes, supporting API docs, ADRs, architecture visuals, onboarding materials, and runbooks for both single services and distributed systems.