用途:以“先制图、再下潜”的方式生成结构化、可视化的系统/代码库架构分析文档,适用于接手陌生代码库、架构评审与技术尽调、需要可分享的分析报告等场景。默认中文输出。
主要能力:全局扫描入口、路由、任务调度、配置、依赖、数据存储与外部集成点,构建至少三层的 mindmap,并将其映射为可检索的章节计划;逐章定向取证,产出含文件路径、关键函数/类、配置项等证据的章节;每章至少包含范围与职责、关键证据、数据/控制流(Mermaid 图)、关键权衡与替代方案、风险分级与修复建议;最终汇总为系统概览、风险清单与优先级路线图。
使用方式:Phase 0 先澄清分析目标、受众与产出范围;Phase 1 在项目根目录生成 metadata.json(须含 mindmap_markdown,建议含 related_files),并执行 node <skill_dir>/lib/doc-generator.js init metadata.json;Phase 2 每次只处理一个章节,写入 section.json(heading 与 content 字段),执行 node <skill_dir>/lib/doc-generator.js append <session_id> section.json;Phase 3 执行 node <skill_dir>/lib/doc-generator.js render <session_id> 完成渲染与质量校验。工具约定优先使用 ls、rg -n、sed -n、git log、git blame 等可复现命令。
限制:必须分章节追加,禁止一次性写完整报告;关键结论须可追溯到文件与入口,禁止空泛描述;重要章节须有 Mermaid 或引用 mindmap 节点;输出 HTML 中展示代码或用户输入必须转义(如 <script>)。具体支持平台细节、收费与价格信息暂未提供。