SuperAPI AI 工具集

docs-generator

写作与研究

查看项目

更新于 10-16 01:19

技能介绍

用途:重构项目文档,使其更清晰、更易访问。触发场景包括用户要求整理文档、生成文档或改进文档结构。

主要能力:先与远程仓库同步,再创建功能分支;通过并行子代理分析项目技术栈、现有文档清单、用户画像与项目目的;随后并行生成根 README、各组件 README 以及 docs/ 目录下的相关文档;使用 Mermaid 绘制架构图、数据流图和数据库 ER 图;最后按质量清单检查内部链接、代码示例、重复信息、格式一致性和既有内容保留情况。

使用方式:编辑前必须同步远程,命令为 branch="$(git rev-parse --abbrev-ref HEAD)"、git fetch origin、git pull --rebase origin "$branch";工作区不干净时先 stash,同步后再 pop;若缺少 origin 或发生冲突,应停止并询问用户。之后创建功能分支,默认回退分支名为 feat/docs-generator。

docs/ 目标结构包含 architecture.md、api-reference.md、database.md、deployment.md、development.md、troubleshooting.md、user-guide.md,但只创建与项目类型相关的文件。

适用场景:需要整理或生成项目文档的代码仓库,尤其适合多模块、多包或微服务项目。

限制:资料未提供具体安装命令、收费方式、平台支持范围或效果保证;文档生成质量依赖项目实际内容,不应使用通用占位符。