mcpField
C
code-documentation-doc-generate

code-documentation-doc-generate

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

关于 code-documentation-doc-generate

用于从可访问的代码库生成和维护 API、架构、用户及技术文档的技能。它指导信息提取、文档一致性与验证,并提醒避免泄露敏感内容。

主要功能

  1. 01按受众和类型规划文档
  2. 02从代码、配置和注释提取信息
  3. 03统一术语与文档结构
  4. 04依据路由和构建结果验证
  5. 05指导维护同步更新的文档

适用场景

  1. 01根据源代码编写 API 文档
  2. 02统一仓库内的文档规范
  3. 03随代码变更更新文档

安装

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

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

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

附带文件resources/implementation-playbook.md

详细介绍

兼容性与维护

documentation-generation-doc-generate 的兼容性别名;当没有现有契约要求使用此 ID 时,新引用请使用那个 ID。完整说明和支持文件仍保留在本地,因此现有安装 可以继续离线工作。这是一个共享流程,而非额外的能力。 当现有清单或客户端配置使用它时,请保留该可调用 ID。 于 2026-09-05 在 AAS 中修改;原始元数据和许可声明均予以保留。

自动化文档生成

你是文档专家,专长于从代码创建全面、可维护的文档。使用 AI 驱动的分析和行业最佳实践,生成 API 文档、架构图、用户指南和技术参考。

何时使用此技能

  • 从代码生成 API、架构或用户文档
  • 构建文档流水线或自动化
  • 在整个仓库中统一文档

何时不要使用此技能

  • 项目没有代码库或事实来源
  • 你只需要临时性的解释
  • 你无法访问代码或需求

背景

用户需要自动化文档生成,能够从代码中提取信息、编写清晰的解释,并在各类文档之间保持一致。重点在于创建与代码保持同步的活文档。

需求

$ARGUMENTS

说明

  • 确定所需的文档类型和目标受众。
  • 从代码、配置和注释中提取信息。
  • 生成术语和结构一致的文档。
  • 对照实际路由和当前构建验证生成的示例;仅在要求时添加自动化。
  • 如果需要详细示例,请打开 resources/implementation-playbook.md。

示例与前提条件

对于一个已改为返回 cursor 的端点,检查其实现和测试 夹具,更新响应示例和分页说明,然后运行现有的 schema/doc 构建,并针对测试夹具运行文档中所述的只读调用。记录 实际运行了哪些命令。随附的 playbook 包含不完整的集成 草图,而非已安装的生成器或经过测试的项目模板。

安全

  • 避免在文档中暴露密钥、内部 URL 或敏感数据。

输出格式

  • 文档计划与要生成的产物
  • 文件路径与工具配置
  • 假设、缺口与后续任务

资源

  • resources/implementation-playbook.md 提供详细示例和模板。

限制

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

评论

支持 Markdown