关于 documentation-generator
documentation-generator 是一项在本地根据源代码生成和更新技术文档的工具，适合维护软件项目文档的开发团队。它可用于更新 API 文档，以及为新成员生成架构图和项目概览。
主要功能
- 01根据源代码生成技术文档
- 02更新 API 文档
- 03生成架构图和项目概览
- 04在本地运行，不上传源代码
适用场景
- 01功能开发完成后更新 API 文档
- 02为新团队成员准备架构概览
- 03维护项目的技术文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/documentation-generator确认已加载。
附带文件skill.yaml
详细介绍
文档生成器
用途和意图
documentation-generator 会直接根据源代码自动创建和更新技术文档，确保软件项目易于维护。
适用场景
- 开发完成后：功能完成后运行，确保 API 文档保持最新。
- 新成员入职：用于为新团队成员生成架构图和概览。
不适用场景
- 高层战略：此工具用于生成技术文档，无法编写“业务需求”或“产品愿景”文档。
安全与数据处理注意事项
- 在本地运行；不会将源代码上传到外部服务器。
评论
支持 Markdown