documentation

Featured

Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.

Data & Documents 39,350 stars 6386 forks Updated today MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Workflow Bundle ## Overview Comprehensive documentation workflow for generating API documentation, architecture documentation, README files, code comments, and technical content from codebases. ## When to Use This Workflow Use this workflow when: - Creating project documentation - Generating API documentation - Writing architecture docs - Documenting code - Creating user guides - Maintaining wikis ## Workflow Phases ### Phase 1: Documentation Planning #### Skills to Invoke - `docs-architect` - Documentation architecture - `documentation-templates` - Documentation templates #### Actions 1. Identify documentation needs 2. Choose documentation tools 3. Plan documentation structure 4. Define style guidelines 5. Set up documentation site #### Copy-Paste Prompts ``` Use @docs-architect to plan documentation structure ``` ``` Use @documentation-templates to set up documentation ``` ### Phase 2: API Documentation #### Skills to Invoke - `api-documenter` - API documentation - `api-documentation-generator` - Auto-generation - `openapi-spec-generation` - OpenAPI specs #### Actions 1. Extract API endpoints 2. Generate OpenAPI specs 3. Create API reference 4. Add usage examples 5. Set up auto-generation #### Copy-Paste Prompts ``` Use @api-documenter to generate API documentation ``` ``` Use @openapi-spec-generation to create OpenAPI specs ``` ### Phase 3: Architecture Documentation #### Skills to Invoke - `c4-architecture-c4-architecture` - C4 architectur...

Details

Author
sickn33
Repository
sickn33/antigravity-awesome-skills
Created
4 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

api-documentation

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

39,350 Updated today
sickn33
Data & Documents Listed

documentation-generator

Generate comprehensive documentation for a codebase by reading the repository and producing READMEs, API docs, architecture docs, and technical references. Use when the user asks to "document this repo", "generate docs", "write a README", "create API documentation", "document this codebase", "write architecture docs", or "produce technical references" for an existing project. NOT for UX copy, button labels, or interface microcopy (use ux-writing). NOT for pedagogical code examples or tutorials (use example-design). NOT for inline code comments. NOT for navigation or sitemap design (use navigation-design).

9 Updated 2 days ago
viktorbezdek
Data & Documents Listed

documentation-generator

Auto-generate technical documentation, README files, and API documentation for software projects.

0 Updated 1 months ago
zm2231
AI & Automation Listed

doc-writer

Write, update, or review documentation (README, ARCHITECTURE.md, API docs, guides). Use after implementing features to document new APIs, CLI commands, or behavior changes.

2 Updated today
wpfleger96
AI & Automation Featured

docs-architect

Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks.

39,350 Updated today
sickn33