← ClaudeAtlas

documentation-generatorlisted

Auto-generate technical documentation, README files, and API documentation for software projects.
zm2231/personal-os-cowork · ★ 0 · Data & Documents · score 67
Install: claude install-skill zm2231/personal-os-cowork
# Documentation Generator Automated generation of technical documentation, README files, API documentation, and code comments. ## Tier 1: Guided Documentation ### What This Skill Does Guides you through generating high-quality documentation automatically from code, tests, and specifications. ### When to Use This Skill - **API Documentation**: Generate from OpenAPI/Swagger specs - **README Files**: Auto-generate project READMEs - **Code Comments**: Add docstrings and comments - **User Guides**: Generate from specifications - **Technical Specs**: Document architecture and design ### Guided Documentation Workflow #### Step 1: Identify Documentation Needs **Documentation Types:** - **User Documentation**: Installation, usage, examples - **API Documentation**: Endpoints, parameters, responses - **Developer Documentation**: Architecture, design decisions - **Code Documentation**: Docstrings, comments, inline docs - **Testing Documentation**: Test coverage, test examples **Assessment Checklist:** ``` ✓ What needs documentation? (API, code, setup) ✓ Who is the audience? (Users, developers, contributors) ✓ What are the key features to document? ✓ What examples should be included? ✓ What installation/setup steps are needed? ``` #### Step 2: Extract Information **Sources for Documentation:** - Code structure and organization - Test files (examples of usage) - API specifications (OpenAPI, GraphQL schema) - Configuration files - Commit messages and PR descriptions - Comments a