用途:调查代码库,为产品经理、创始人、支持负责人或新成员等非开发者编写业务逻辑文档,讲清系统行为而非代码写法。\n\n主要能力:以业务语言解释系统;默认输出到仓库根目录下的 resource/ai-doc/(可用 git rev-parse --show-toplevel 定位根目录);若已有文档套件则更新而非替换;主题文件采用“业务正文 + 底部代码锚点表”的双读者结构;使用 Mermaid 绘制流程图、时序图、状态图;区分核心流程与次要内容,并明确标注无法确认的缺口。\n\n使用方式:先阅读 README、package.json/清单和目录结构进行定位;若存在 .codegraph/ 可通过 ToolSearch 加载 codegraph_explore;用多个 code-explorer 子代理并行调查各子系统,并让其返回 file:line 锚点;核心流程需自行追读入口;仅记录代码可验证的内容,代码与注释/文档冲突时以代码为准。\n\n适用场景:需要为既有代码库生成或更新面向非技术读者的业务文档。\n\n限制:需要可访问的代码库;不记录仅凭命名推断的行为;不确定处需标注或省略;文中未提供具体价格、平台或性能数据。
ai-documentation
写作与研究
更新于 10-15 18:45