技能 documentation-generation-doc-generate
📦
documentation-generation-doc-generate
安全
从代码生成全面的文档
自动保持文档与代码同步。此技能从源代码中提取信息，创建 API 规范、架构图和用户指南，随着代码库的演变保持最新。
支持: Claude Codex Code(CC)
1
下载技能 ZIP
2
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
3
开启并开始使用
测试它
正在使用“documentation-generation-doc-generate”。 分析 src/routes/ 中的 Python API 路由
预期结果:
- OpenAPI 3.0 规范文件 (openapi.yaml)
- 交互式 API 文档 HTML 页面
- 每个端点的 Python、JavaScript 和 cURL 代码示例
正在使用“documentation-generation-doc-generate”。 记录微服务架构
预期结果:
- 显示服务关系的系统架构图
- 包含技术栈和职责的组件文档
- 关键业务流程的数据流图
安全审计
安全v1 • 2/24/2026
This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
2
已扫描文件
692
分析行数
0
发现项
1
审计总数
未发现安全问题
审计者: claude
质量评分
38
架构
100
可维护性
87
内容
50
社区
100
安全
100
规范符合性
你能构建什么
API 文档生成
从代码库注释和路由定义自动生成 OpenAPI 规范和交互式 API 文档。
架构文档
通过分析导入、依赖项和代码结构创建系统架构图和组件文档。
文档流程自动化
设置 CI/CD 工作流，在每次代码提交时重新生成和部署文档以保持同步。
试试这些提示
基础 API 文档
分析 ./src/api/ 目录中的 Python 文件，生成包含所有端点、请求/响应模式和认证要求的 OpenAPI 3.0 规范。
README 生成
为该仓库创建全面的 README.md，包括安装说明、配置选项、使用示例和贡献指南，基于代码结构。
架构图
检查服务模块及其导入，创建显示系统架构、数据流和组件依赖关系的 Mermaid 图。
完整文档套件
生成完整文档，包括 API 参考、架构概述、入门指南和部署说明。使用生成的构件设置带有搜索功能的文档站点。
最佳实践
- 将文档生成作为 CI/CD 的一部分运行，以保持文档与代码变更同步
- 包含文档覆盖率检查，当覆盖率低于阈值时使构建失败
- 审查生成的文档以确保准确性，并在需要时添加人工上下文
避免
- 生成一次文档后，随着代码演变不再更新
- 未经人工审查准确性就发布生成的文档
- 在生成的文档中包含敏感信息，如 API 密钥或内部 URL
常见问题
文档生成支持哪些编程语言？
此技能最适合 Python、JavaScript、TypeScript 和 Go。它可以分析其他具有基于 AST 的文档提取功能的语言，但对不太常见的语言支持可能有限。
此技能可以为私有仓库生成文档吗？
是的，当在 Claude Code 或 Codex 中运行并可以访问您的仓库时，此技能可以分析并为私有代码库生成文档。
如何保持生成的文档最新？
设置 CI/CD 工作流，在代码变更时触发文档重新生成。此技能包含用于自动化文档流程的示例 GitHub Actions 工作流。
可以生成哪些文档格式？
OpenAPI/Swagger 规范、Markdown 文档、Mermaid 图、HTML 文档站点和用于 Sphinx 集成的 reStructuredText。
此技能会取代人工技术作者吗？
不。它自动化重复的文档任务并生成参考文档，但人工作者对于叙述性内容、教程和确保文档质量至关重要。
生成的文档有多准确？
准确性取决于代码质量和注释。具有类型提示和文档字符串的良好记录的代码会产生更好的结果。发布前务必审查生成的文档。