Does it support architectural diagrams?

Yes, it can generate high-level system architecture descriptions and component interactions using text-based formats like ASCII or Mermaid.

Can it help with operational maintenance?

Yes, by using the --runbook command, the skill creates operational documentation including health checks, monitoring steps, and recovery procedures for your services.

Is the documentation kept in the repository?

Yes, the skill follows 'docs-as-code' best practices, facilitating the storage and maintenance of documentation directly within your version-controlled repository.

How does the skill generate API documentation?

The skill uses file analysis tools to read your service code, identify endpoints and data models, and then outputs a standardized OpenAPI 3.0 specification.

Documentation Expert

Name: Documentation Expert
Author: rikdc

byrikdc

•

学习与文档

Generates and maintains comprehensive technical documentation including API specs, architecture records, and operational runbooks.

This skill transforms Claude into a specialized technical writer capable of auditing your codebase to produce high-quality, maintainable documentation. It automates the creation of OpenAPI specifications, Architecture Decision Records (ADRs), system architecture diagrams, and developer onboarding guides by analyzing your source code and git history. Whether you need to document a new API endpoint or record a complex architectural decision, this skill ensures your documentation remains accurate, structured, and synchronized with your implementation.

主要功能

01System architecture documentation using ASCII or Mermaid diagrams

02Comprehensive operational runbooks covering health checks and troubleshooting

03Standardized Architecture Decision Record (ADR) creation with rationale and consequences

042 GitHub stars

05Automated OpenAPI 3.0/Swagger specification generation from service code

06Interactive developer onboarding guides and project structure overviews

使用场景

01Documenting a legacy codebase to help new team members understand system architecture

02Generating API documentation automatically before a major service release or integration

03Recording critical design decisions in ADR format to maintain a clear project history

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rikdc/claude_code_template document

For use in Claude.ai and ChatGPT

Download Skill