用途
这是一个文档生成工作流合集(Documentation Workflow Bundle),用于从代码库中生成 API 文档、架构文档、README 文件、代码注释和技术内容。适用于创建项目文档、生成 API 文档、编写架构文档、记录代码、创建用户指南、维护 Wiki 等场景。
主要能力
工作流按阶段组织,每个阶段列出可调用的技能和可复制的提示词:
- 阶段 1:文档规划。调用 docs-architect、documentation-templates,识别文档需求、选择工具、规划结构、定义风格指南、搭建文档站点。
- 阶段 2:API 文档。调用 api-documenter、api-documentation-generator、openapi-spec-generation,提取 API 端点、生成 OpenAPI 规范、创建 API 参考、添加使用示例、设置自动生成。
- 阶段 3:架构文档。调用 c4-architecture-c4-architecture、c4-context、c4-container、c4-component、c4-code、mermaid-expert,创建 C4 图、记录架构、生成序列图、记录数据流、创建部署文档。
- 阶段 4:代码文档。调用 code-documentation-code-explain、code-documentation-doc-generate、documentation-generation-doc-generate,提取代码注释、生成 JSDoc/TSDoc、创建类型文档、记录函数、添加使用示例。
- 阶段 5:README 与入门。调用 readme、environment-setup-guide、tutorial-engineer,创建 README、编写入门指南、记录安装、添加使用示例、创建故障排除指南。
- 阶段 6:Wiki 与知识库。调用 wiki-architect、wiki-page-writer、wiki-onboarding、wiki-qa、wiki-researcher、wiki-vitepress,设计 Wiki 结构、创建页面、编写入职指南、记录流程、搭建 Wiki 站点。
- 阶段 7:变更日志与发布说明。调用 changelog-automation、wiki-changelog,提取提交历史、分类变更、生成变更日志、创建发布说明。
- 阶段 8:文档维护。调用 doc-coauthoring、reference-builder,审查文档、更新过时内容、修复失效链接、添加新功能、收集反馈。
文档类型涵盖代码级(JSDoc/TSDoc 注释、函数文档、类型定义、示例代码)、API 文档(端点参考、请求/响应模式、认证指南、SDK 文档)、架构文档(系统概览、组件图、数据流图、部署架构)、用户文档(入门指南、用户手册、教程、FAQ)和流程文档(运行手册、入职指南、SOP、决策记录)。
使用方式
按需选择请求所需的阶段;该合集并不授权所有被引用的技能或外部发布。调用前需验证每个 ID 和本地前置条件。保留现有文档,区分提议决策与已接受决策,避免将私有数据放入公开示例,并运行项目实际的文档检查。每个阶段提供可复制的提示词,例如“Use @docs-architect to plan documentation structure”“Use @api-documenter to generate API documentation”等。
质量门禁
所有 API 已记录、架构图保持最新、README 保持更新、代码注释有帮助、示例可运行、链接有效。
适用场景
创建项目文档、生成 API 文档、编写架构文档、记录代码、创建用户指南、维护 Wiki、生成变更日志与发布说明、文档维护与协作写作。
限制
仅在任务明确匹配上述范围时使用此技能。不要将输出视为环境特定验证、测试或专家审查的替代品。如果缺少必需的输入、权限、安全边界或成功标准,应停止并请求澄清。相关的工作流合集包括 development(开发工作流)、testing-qa(文档测试)、ai-ml(AI 文档)。