SuperAPI AI 工具集

document-multiple-repository

写作与研究

查看项目

更新于 10-15 17:26

技能介绍

用途:该技能用于为多仓库组成的软件系统(前端、后端、微服务、基础设施、docs、wiki)生成整合技术文档,前提是所有仓库(含 wiki)已克隆到本地共享文件系统同一位置。

输入:ROOT_PATH(包含多个系统的目录)、OUTPUT_PATH(生成文档的目标位置)、TEMPLATES_PATH(README、ARCHITECTURE、API、CODE_COMMENTS 模板)。

主要处理步骤:1)发现系统:递归扫描 ROOT_PATH,识别含 .git 的仓库,识别目录名以 .wiki 结尾的 wiki 仓库,按文件系统邻近度聚类为单一逻辑系统;2)分析仓库:判定类型(code、docs、wiki),代码仓库检测语言与框架(如 Spring、Django、Node)及服务类型(后端、前端、微服务、基础设施),提取 README、构建文件、清单、API 路由、实体与配置;wiki 仓库提取主页面(Home.md、index.md)、基础设施指南、安装教程、业务过程(DoR/DoD)与外部链接;docs 仓库检测静态生成器(MkDocs、Sphinx)并提取功能手册与用户指南;3)生成文档:为每个系统生成 SYSTEM_OVERVIEW.md、ARCHITECTURE.md、REPOSITORY_MAP.md、DEPLOYMENT.md、PROCESSES_AND_GUIDELINES.md,为每个仓库生成 README.generated.md、API.generated.md,代码仓库另加 CODE_STRUCTURE.md,wiki 仓库另加 WIKI_SUMMARY.md;4)输出结构按 OUTPUT_PATH/system-name/ 与 repos/repo-name/ 组织。

使用方式:由 AI 代理(VS Code、Copilot、Gemini CLI 等)手动执行命令 "Run skill document-multiple-repository on <ROOT_PATH>"。

限制:不执行代码、不修改原始仓库,仅产出文档;资料未提供具体支持的框架完整清单、性能与规模上限、收费方式。