documentation

Featured

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

Data & Documents 38,979 stars 6339 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

Related Skills