用途:为代码库生成一份全面的入门文档,通过并行探索加速理解项目结构。
主要能力:启动 5 个只读探索子代理,分别负责架构与结构、数据模型与数据库、API 路由与端点、认证与授权、部署与基础设施。每个代理调查各自领域,最后汇总为单一文档。
使用方式:按工作流启动并行探索,各代理分别输出发现;随后综合结果,生成包含快速开始、架构、数据模型、API 参考、认证、部署、关键文件等章节的文档;最后写入项目根目录的 ONBOARDING.md,或用户指定位置。快速开始部分包含克隆仓库、安装依赖、配置环境、运行数据库迁移、启动开发服务器等步骤。
适用场景:新成员加入项目、需要快速了解陌生代码库、为团队整理项目文档。
限制:每个探索代理为只读且快速,整个过程不到一分钟;单体仓库可考虑为每个应用或包增加一个代理;文档应突出重点“从这里开始”的文件,并包含常见设置问题、易忘环境变量和必需系统依赖等注意事项。具体命令与配置因项目而异,资料未提供固定命令。