SuperAPI AI 工具集

generate-docs

写作与研究

查看项目

更新于 10-16 05:47

技能介绍

用途:从现有代码库生成结构化项目文档,供智能体与人类在后续会话中协作使用。产出三类文件:项目概览 docs/overview.md(高层架构、模块与功能清单)、模块文档 docs/modules/<name>.md(职责、依赖、边界,以及文件/目录与符号的详尽清单)、功能文档 docs/features/<name>.md(功能如何工作及实现引用)。

适用场景:项目尚无结构化文档、需要熟悉陌生代码库,或用户要求“为项目写文档”。不用于更新已有文档,更新应使用 update-docs。

执行方式:主智能体启动 doc-explorer,由其在 docs/ 下探索仓库并写入产物;文档主要锚定代码库而非对话,探索与写入放在同一子智能体会话以减少上下文丢失。主智能体应保持聊天输出精简,仅报告变更路径与未决问题。

自委派:项目含 3 个以上模块或单模块超过 50 个文件时,doc-explorer 应通过 Task 工具按模块委派给独立实例。编排实例识别模块、创建 docs/overview.md 并派生按模块实例;按模块实例接收限定任务,仅探索该模块并写 docs/modules/<name>.md;编排实例收集状态并撰写跨领域功能文档,以避免单一上下文过度膨胀。

工作流:评估项目(用 read/glob/grep 与 git 历史识别类型、语言、框架、入口、模块与功能,检查已有文档);识别模块(自包含、职责清晰、可独立替换);创建项目概览;创建模块文档(概览、结构、关键符号、数据流);创建功能文档(用户流程、技术流程、实现引用、边界与限制);验证交叉引用并报告缺口。

规则:输出全部写入 docs/ 目录文件,不以聊天消息返回;概览与模块/功能文档间不重复,用引用;不假设语言或框架;文件/目录与符号清单必须附用途说明;不使用内置 explore 子智能体,改用 doc-explorer;写前确保 docs/、docs/modules/、docs/features/ 存在;输出须遵循随附模板的标题与 frontmatter 键。功能文档天然不完整,记录可发现内容并标注缺口。