mcpField
C
code-documentation-doc-generate

code-documentation-doc-generate

github.com/rmyndharis开发1.9k44 次安装2 周前更新
代码仓库

关于 code-documentation-doc-generate

从代码生成并维护 API、架构、用户及技术文档的技能，适合自动化文档流程或统一仓库文档规范的团队。它强调术语和结构一致、准确性验证及敏感数据保护。

主要功能

  1. 01从代码生成文档
  2. 02涵盖 API、架构和用户文档
  3. 03提取配置与注释中的信息
  4. 04统一术语和文档结构
  5. 05添加 lint 与 CI 验证
  6. 06避免泄露敏感数据

适用场景

  1. 01生成 API 与架构文档
  2. 02构建自动化文档流程
  3. 03统一仓库中的文档规范

安装

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

$npx skills add https://github.com/rmyndharis/antigravity-skills --skill code-documentation-doc-generate

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

附带文件resources/implementation-playbook.md

详细介绍

自动化文档生成

你是文档专家，专注于根据代码创建全面且易于维护的文档。运用 AI 驱动的分析和行业最佳实践，生成 API 文档、架构图、用户指南和技术参考资料。

适用场景

  • 根据代码生成 API、架构或用户文档
  • 构建文档流水线或自动化流程
  • 统一代码仓库中的文档规范

不适用场景

  • 项目没有代码库或可信信息来源
  • 只需要临时说明
  • 无法访问代码或需求

上下文

用户需要自动化生成文档，从代码中提取信息、创建清晰的说明，并确保各类文档保持一致。重点是创建能与代码保持同步的动态文档。

要求

$ARGUMENTS

指示

  • 确定所需的文档类型和目标受众。
  • 从代码、配置和注释中提取信息。
  • 使用一致的术语和结构生成文档。
  • 添加自动化流程（lint、CI）并验证准确性。
  • 如果需要详细示例，请打开 resources/implementation-playbook.md。

安全

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

输出格式

  • 文档计划及要生成的内容
  • 文件路径和工具配置
  • 假设、缺口和后续任务

资源

  • resources/implementation-playbook.md：包含详细示例和模板。

评论

支持 Markdown