Linear Walkthrough 用于为陌生代码库生成结构化、端到端的线性走查文档,说明从入口点贯通主要执行路径的代码运作方式。它通过编排并行子代理完成四个阶段的工作。
用途:面向需要真正理解代码库的工程师,帮助其快速上手,输出可导航、经过事实核查的解释,而非营销式摘要。
主要能力:按四阶段流程组织。阶段一为发现与规划,生成:walkthrough/coverage-plan.md 和 walkthrough/entry-points.md,包含代理分配(ID、范围、文件、入口点、token 预算),并校验读取预算,若任一分配超过 50k token 读取预算,会先拆分该分配。阶段二为生成,按覆盖计划中的每个分配并行启动追踪代理,每个代理最多读取 50k token 源码,产出:walkthrough/sections/walkthrough-section-{id}.md。若某些分节未产出,会记录为缺口并标记待验证。阶段三为验证,按交叉轮换方式分配验证代理,检查其他代理的分节,产出:walkthrough/validation/validation-report-{id}.md;如报告含关键修正(错误排序、臆造行为、断链引用),会为受影响分节启动修正代理就地编辑。阶段四为综合,合并已验证分节、验证报告与入口点索引,产出:walkthrough/unified-walkthrough.md 和 walkthrough/open-questions.md。若 unified-walkthrough.md 超过 25k 字符,会采用多文件拆分(walkthrough/unified/index.md 及各分节文件,每个低于 25k 字符);若调用方明确要求单文件,则采用骨架加编辑填充策略。
使用方式:以命令 /linear-walkthrough 加目标目录调用,目标目录默认当前工作目录;输出目录为 <target-directory>/walkthrough/,不存在时创建。若提供流程映射或 Mermaid 图,则作为权威流程执行,按所示顺序、分支、决策点和停止条件逐步执行;遇到歧义或缺少必要细节应先暂停提问。与用户交互时,先报告将遵循的路径再执行。
操作规则:先广后深,先看目录结构、配置、README,再看源码与实现细节;优先读取架构文档与配置;资料优先级为代码、配置、测试、脚本、CI/CD、文档;用测试与部署配置作为预期行为的证据;在 open-questions.md 中明确记录部分覆盖与未覆盖区域;代码库过大时优先覆盖最重要的操作路径,其余标记为部分覆盖;除非共享基础设施、框架引导或横切关注点需要,代理之间不应重叠文件覆盖;覆盖计划须明确记录哪些文件分配给哪个代理及原因。
质量标准:优先使用具体文件路径、符号、命令、配置和接口,而非模糊总结;不臆造仓库不支持的意图或架构;未支持的声明标记为 [INFERENCE];清楚区分代码/配置中的已验证事实、合理推断与未解决的不确定性。
资源:agent-instructions.md 提供各代理类型(发现、追踪、验证、综合)的详细提示;output-format.md 提供所有产物的必需结构与模板。
限制:资料未提供具体的收费、价格、平台支持、性能效果或更细的使用步骤;上述未提及的功能、效果或收费情况暂未提供。