SuperAPI AI 工具集

project-docs-init

通用与其它

查看项目

更新于 10-16 09:45

技能介绍

用途:帮助新项目或已有代码项目建立完整、规范的技术文档体系,通过多轮对话收集信息并生成文档。

主要能力:支持两种模式。模式A从需求创建文档,适合新项目启动;模式B从代码回补文档,适合已有代码但文档缺失或过时的情况。流程包括判断模式、发现或分析阶段、需求与差异分析、架构设计或需求确认、文档生成、审查确认。产出包括 docs/README.md、docs/specs/PRD.md、docs/specs/SAD.md、docs/guides/AI-DEVELOPMENT-GUIDE.md、docs/modules/*.md、docs/database/SCHEMA.md、docs/database/MIGRATIONS.md、docs/api/api-spec.md 以及 docs/plans 目录。

使用方式:由 AI 助手按阶段引导对话,模式判断时会检查代码目录、项目配置文件和 git 历史;生成文档前需与用户确认范围和详细程度。涉及探索代码时使用 Task tool 的 Explore agent,涉及关键确认时使用 AskUserQuestion。

适用场景:新项目建立文档体系、现有项目补充规范文档、根据代码回补文档。

限制:资料未提供具体安装命令、价格、平台支持、运行环境或效果保证;文档内容依赖用户补充业务背景和确认信息,无法保证完全自动生成。