mcpField
D
documentation

documentation

github.com/sickn33开发49.1k277 次安装今天更新
代码仓库

关于 documentation

面向软件项目的文档工作流技能包，涵盖 API、架构、代码、用户指南和维护文档。适合需要按阶段规划并检查文档产出的开发团队。

主要功能

  1. 01规划文档结构与规范
  2. 02编写 API 与架构文档
  3. 03生成代码注释和说明
  4. 04制作 README、指南与 Wiki
  5. 05维护变更记录并检查质量

适用场景

  1. 01为代码库规划文档体系
  2. 02生成 API 参考和 OpenAPI 规范
  3. 03编写架构图及数据流说明
  4. 04更新指南、Wiki 与版本说明

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill documentation

安装后在 Claude Code 中输入/documentation确认已加载。

详细介绍

文档工作流包

概述

全面的文档工作流，可根据代码库生成 API 文档、架构文档、README 文件、代码注释和技术内容。

何时使用此工作流

在以下情况下使用此工作流：

  • 创建项目文档
  • 生成 API 文档
  • 编写架构文档
  • 编写代码文档
  • 创建用户指南
  • 维护 Wiki

范围

仅选择请求所需的阶段；此工作流包并未授权使用所有引用的技能或进行外部发布。调用前，请核实每个 ID 及本地前置条件。保留现有文档，区分提议的决策和已接受的决策，不要在公开示例中包含私密数据，并运行项目实际使用的文档检查。

工作流阶段

阶段 1：文档规划
要调用的技能
  • docs-architect - 文档架构
  • documentation-templates - 文档模板
操作
  1. 确定文档需求
  2. 选择文档工具
  3. 规划文档结构
  4. 制定风格指南
  5. 设置文档站点
可复制粘贴的提示词
Use @docs-architect to plan documentation structure

Use @documentation-templates to set up documentation
阶段 2：API 文档
要调用的技能
  • api-documenter - API 文档
  • api-documentation-generator - 自动生成
  • openapi-spec-generation - OpenAPI 规范
操作
  1. 提取 API 端点
  2. 生成 OpenAPI 规范
  3. 创建 API 参考文档
  4. 添加使用示例
  5. 设置自动生成
可复制粘贴的提示词
Use @api-documenter to generate API documentation

Use @openapi-spec-generation to create OpenAPI specs
阶段 3：架构文档
要调用的技能
  • c4-architecture-c4-architecture - C4 架构
  • c4-context - 上下文图
  • c4-container - 容器图
  • c4-component - 组件图
  • c4-code - 代码图
  • mermaid-expert - Mermaid 图表
操作
  1. 创建 C4 图表
  2. 编写架构文档
  3. 生成时序图
  4. 编写数据流文档
  5. 创建部署文档
可复制粘贴的提示词
Use @c4-architecture-c4-architecture to create C4 diagrams

Use @mermaid-expert to create architecture diagrams
阶段 4：代码文档
要调用的技能
  • code-documentation-code-explain - 代码说明
  • code-documentation-doc-generate - 生成文档
  • documentation-generation-doc-generate - 自动生成
操作
  1. 提取代码注释
  2. 生成 JSDoc/TSDoc
  3. 创建类型文档
  4. 编写函数文档
  5. 添加使用示例
可复制粘贴的提示词
Use @code-documentation-code-explain to explain code

Use @code-documentation-doc-generate to generate docs
阶段 5：README 和入门指南
要调用的技能
  • readme - 生成 README
  • environment-setup-guide - 环境设置指南
  • tutorial-engineer - 创建教程
操作
  1. 创建 README
  2. 编写入门指南
  3. 编写安装文档
  4. 添加使用示例
  5. 创建故障排除指南
可复制粘贴的提示词
Use @readme to create project README

Use @tutorial-engineer to create tutorials
阶段 6：Wiki 和知识库
要调用的技能
  • wiki-architect - Wiki 架构
  • wiki-page-writer - Wiki 页面
  • wiki-onboarding - 入门文档
  • wiki-qa - Wiki 问答
  • wiki-researcher - Wiki 研究
  • wiki-vitepress - VitePress Wiki
操作
  1. 设计 Wiki 结构
  2. 创建 Wiki 页面
  3. 编写入门指南
  4. 编写流程文档
  5. 设置 Wiki 站点
可复制粘贴的提示词
Use @wiki-architect to design wiki structure

Use @wiki-page-writer to create wiki pages

Use @wiki-onboarding to create onboarding docs
阶段 7：变更日志和发行说明
要调用的技能
  • changelog-automation - 生成变更日志
  • wiki-changelog - 根据 git 生成变更日志
操作
  1. 提取提交历史
  2. 对变更进行分类
  3. 生成变更日志
  4. 创建发行说明
  5. 准备更新；仅发布到明确授权的目标位置
可复制粘贴的提示词
Use @changelog-automation to generate changelog

Use @wiki-changelog to create release notes
阶段 8：文档维护
要调用的技能
  • doc-coauthoring - 协作写作
  • reference-builder - 参考文档
操作
  1. 审阅文档
  2. 更新过时内容
  3. 修复失效链接
  4. 添加新功能
  5. 收集反馈
可复制粘贴的提示词
Use @doc-coauthoring to collaborate on docs

文档类型

代码级文档
  • JSDoc/TSDoc 注释
  • 函数文档
  • 类型定义
  • 示例代码
API 文档
  • 端点参考
  • 请求/响应模式
  • 身份验证指南
  • SDK 文档
架构文档
  • 系统概览
  • 组件图
  • 数据流图
  • 部署架构
用户文档
  • 入门指南
  • 用户手册
  • 教程
  • 常见问题
流程文档
  • 操作手册
  • 入职指南
  • SOP
  • 决策记录

质量门槛

  • 所有 API 均有文档说明
  • 架构图保持最新
  • README 保持最新
  • 代码注释有帮助
  • 示例可正常运行
  • 链接有效

相关工作流包

  • development - 开发工作流
  • testing-qa - 文档测试
  • ai-ml - AI 文档

限制

  • 仅当任务明确符合上述范围时，才使用此技能。
  • 不要将输出视为环境特定验证、测试或专家审查的替代品。
  • 如果缺少必要输入、权限、安全边界或成功标准，请停止并请求澄清。

评论

支持 Markdown