[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill-832d4055-5c90-4798-bca7-7a11876d4573":3,"$f_z0wmfYYfph0_IAaFZLpU74kdWen8nFH9NaSAzM53M0":42},{"id":4,"title":5,"description":6,"categoryId":7,"moduleId":8,"tags":9,"prompt":10,"icon":11,"source":12,"sourceUrl":13,"authorId":14,"authorName":15,"isPublic":16,"stars":17,"runs":18,"createdAt":19,"updatedAt":19,"module":20,"category":27,"packages":33},"832d4055-5c90-4798-bca7-7a11876d4573","documentation","涵盖API文档、架构文档、README文件、代码注释和技术写作的文档生成工作流程。","cat_coding_backend","mod_coding","sickn33,coding","---\nname: documentation\ndescription: \"Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.\"\ncategory: workflow-bundle\nrisk: safe\nsource: personal\ndate_added: \"2026-02-27\"\n---\n\n# Documentation Workflow Bundle\n\n## Overview\n\nComprehensive documentation workflow for generating API documentation, architecture documentation, README files, code comments, and technical content from codebases.\n\n## When to Use This Workflow\n\nUse this workflow when:\n- Creating project documentation\n- Generating API documentation\n- Writing architecture docs\n- Documenting code\n- Creating user guides\n- Maintaining wikis\n\n## Workflow Phases\n\n### Phase 1: Documentation Planning\n\n#### Skills to Invoke\n- `docs-architect` - Documentation architecture\n- `documentation-templates` - Documentation templates\n\n#### Actions\n1. Identify documentation needs\n2. Choose documentation tools\n3. Plan documentation structure\n4. Define style guidelines\n5. Set up documentation site\n\n#### Copy-Paste Prompts\n```\nUse @docs-architect to plan documentation structure\n```\n\n```\nUse @documentation-templates to set up documentation\n```\n\n### Phase 2: API Documentation\n\n#### Skills to Invoke\n- `api-documenter` - API documentation\n- `api-documentation-generator` - Auto-generation\n- `openapi-spec-generation` - OpenAPI specs\n\n#### Actions\n1. Extract API endpoints\n2. Generate OpenAPI specs\n3. Create API reference\n4. Add usage examples\n5. Set up auto-generation\n\n#### Copy-Paste Prompts\n```\nUse @api-documenter to generate API documentation\n```\n\n```\nUse @openapi-spec-generation to create OpenAPI specs\n```\n\n### Phase 3: Architecture Documentation\n\n#### Skills to Invoke\n- `c4-architecture-c4-architecture` - C4 architecture\n- `c4-context` - Context diagrams\n- `c4-container` - Container diagrams\n- `c4-component` - Component diagrams\n- `c4-code` - Code diagrams\n- `mermaid-expert` - Mermaid diagrams\n\n#### Actions\n1. Create C4 diagrams\n2. Document architecture\n3. Generate sequence diagrams\n4. Document data flows\n5. Create deployment docs\n\n#### Copy-Paste Prompts\n```\nUse @c4-architecture-c4-architecture to create C4 diagrams\n```\n\n```\nUse @mermaid-expert to create architecture diagrams\n```\n\n### Phase 4: Code Documentation\n\n#### Skills to Invoke\n- `code-documentation-code-explain` - Code explanation\n- `code-documentation-doc-generate` - Doc generation\n- `documentation-generation-doc-generate` - Auto-generation\n\n#### Actions\n1. Extract code comments\n2. Generate JSDoc\u002FTSDoc\n3. Create type documentation\n4. Document functions\n5. Add usage examples\n\n#### Copy-Paste Prompts\n```\nUse @code-documentation-code-explain to explain code\n```\n\n```\nUse @code-documentation-doc-generate to generate docs\n```\n\n### Phase 5: README and Getting Started\n\n#### Skills to Invoke\n- `readme` - README generation\n- `environment-setup-guide` - Setup guides\n- `tutorial-engineer` - Tutorial creation\n\n#### Actions\n1. Create README\n2. Write getting started guide\n3. Document installation\n4. Add usage examples\n5. Create troubleshooting guide\n\n#### Copy-Paste Prompts\n```\nUse @readme to create project README\n```\n\n```\nUse @tutorial-engineer to create tutorials\n```\n\n### Phase 6: Wiki and Knowledge Base\n\n#### Skills to Invoke\n- `wiki-architect` - Wiki architecture\n- `wiki-page-writer` - Wiki pages\n- `wiki-onboarding` - Onboarding docs\n- `wiki-qa` - Wiki Q&A\n- `wiki-researcher` - Wiki research\n- `wiki-vitepress` - VitePress wiki\n\n#### Actions\n1. Design wiki structure\n2. Create wiki pages\n3. Write onboarding guides\n4. Document processes\n5. Set up wiki site\n\n#### Copy-Paste Prompts\n```\nUse @wiki-architect to design wiki structure\n```\n\n```\nUse @wiki-page-writer to create wiki pages\n```\n\n```\nUse @wiki-onboarding to create onboarding docs\n```\n\n### Phase 7: Changelog and Release Notes\n\n#### Skills to Invoke\n- `changelog-automation` - Changelog generation\n- `wiki-changelog` - Changelog from git\n\n#### Actions\n1. Extract commit history\n2. Categorize changes\n3. Generate changelog\n4. Create release notes\n5. Publish updates\n\n#### Copy-Paste Prompts\n```\nUse @changelog-automation to generate changelog\n```\n\n```\nUse @wiki-changelog to create release notes\n```\n\n### Phase 8: Documentation Maintenance\n\n#### Skills to Invoke\n- `doc-coauthoring` - Collaborative writing\n- `reference-builder` - Reference docs\n\n#### Actions\n1. Review documentation\n2. Update outdated content\n3. Fix broken links\n4. Add new features\n5. Gather feedback\n\n#### Copy-Paste Prompts\n```\nUse @doc-coauthoring to collaborate on docs\n```\n\n## Documentation Types\n\n### Code-Level\n- JSDoc\u002FTSDoc comments\n- Function documentation\n- Type definitions\n- Example code\n\n### API Documentation\n- Endpoint reference\n- Request\u002Fresponse schemas\n- Authentication guides\n- SDK documentation\n\n### Architecture Documentation\n- System overview\n- Component diagrams\n- Data flow diagrams\n- Deployment architecture\n\n### User Documentation\n- Getting started guides\n- User manuals\n- Tutorials\n- FAQs\n\n### Process Documentation\n- Runbooks\n- Onboarding guides\n- SOPs\n- Decision records\n\n## Quality Gates\n\n- [ ] All APIs documented\n- [ ] Architecture diagrams current\n- [ ] README up to date\n- [ ] Code comments helpful\n- [ ] Examples working\n- [ ] Links valid\n\n## Related Workflow Bundles\n\n- `development` - Development workflow\n- `testing-qa` - Documentation testing\n- `ai-ml` - AI documentation\n\n## Limitations\n- Use this skill only when the task clearly matches the scope described above.\n- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.\n- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.\n","","imported","https:\u002F\u002Fgithub.com\u002Fsickn33\u002Fantigravity-awesome-skills","user_system_seed","SkillOPIC",true,95,876,"2026-05-16 13:15:46",{"id":8,"name":21,"slug":22,"icon":23,"description":24,"sort":25,"createdAt":26},"编程开发","coding","mdi-code-braces","代码生成、调试、审查，提升开发效率",2,"2026-05-16 12:53:40",{"id":7,"name":28,"slug":29,"icon":30,"description":31,"moduleId":8,"sort":25,"skillCount":32,"createdAt":26},"后端开发","backend","mdi-server","API、数据库、服务端架构",296,[34],{"id":35,"skillId":4,"version":36,"fileName":37,"fileSize":38,"filePath":39,"fileHash":40,"manifest":41,"createdAt":19},"f7f142a3-c7d3-4358-8377-e507f64cc65a","1.0.0","documentation.zip",1991,"uploads\u002Fskills\u002F832d4055-5c90-4798-bca7-7a11876d4573\u002Fdocumentation.zip","652aabdcd4a782634bec605fc35005a41f76cac23dedc8abf8501a00866c666d","[{\"path\":\"SKILL.md\",\"isDirectory\":false,\"size\":5665}]",{"code":43,"message":44,"data":45},200,"success",{"items":46,"stats":47,"page":50},[],{"averageRating":48,"totalRatings":48,"ratingCounts":49},0,[48,48,48,48,48],{"limit":51,"offset":48,"hasMore":52,"nextOffset":51,"ratedOnly":16},15,false]