How do I trigger the documentation process?

The skill auto-invokes when you use phrases like 'generate docs' or 'write README'. You can also use the explicit /doc-generate command for more control.

What documentation formats are supported?

The skill supports Markdown for guides, OpenAPI/Swagger for REST APIs, and inline documentation formats like JSDoc, TSDoc, and Python Docstrings.

Can this skill handle large, complex codebases?

Yes, for comprehensive systems, the skill routes to the specialized docs-architect agent, which is optimized for deep codebase analysis and generating 10-100+ page technical manuals.

Does it document frontend components?

Yes, it includes specific patterns for documenting UI components, including props, parameters, usage examples, and edge cases.

Documentation Generator

Name: Documentation Generator
Author: joaquimscosta

byjoaquimscosta

•

학습 및 문서화

Generates comprehensive technical documentation, READMEs, and API references directly from your source code.

소개

This skill empowers Claude to create high-quality documentation artifacts ranging from simple README files and JSDoc strings to complex, 100+ page architecture guides and technical manuals. By analyzing codebase structure and logic, it automates the creation of OpenAPI specifications, component references, and installation guides. Whether you need a quick setup guide or a deep-dive architectural rationale, this skill leverages the docs-architect agent to ensure your project remains well-documented and accessible for both developers and stakeholders.

주요 기능

OpenAPI/Swagger specification creation for REST APIs
Automated README and Quick Start guide generation
Detailed component and function-level documentation patterns
Comprehensive architecture guides and technical manuals via docs-architect
3 GitHub stars
Support for multiple formats including Markdown, JSDoc, and Docstrings

사용 사례

Generating professional README files for new GitHub repositories
Creating comprehensive API references for backend services
Building 100+ page technical architecture manuals for enterprise systems

소개

주요 기능

OpenAPI/Swagger specification creation for REST APIs
Automated README and Quick Start guide generation
Detailed component and function-level documentation patterns
Comprehensive architecture guides and technical manuals via docs-architect
3 GitHub stars
Support for multiple formats including Markdown, JSDoc, and Docstrings

사용 사례

Generating professional README files for new GitHub repositories
Creating comprehensive API references for backend services
Building 100+ page technical architecture manuals for enterprise systems