SuperAPI AI 工具集

recipe-update-doc

写作与研究

查看项目

更新于 10-16 02:41

技能介绍

用途

recipe-update-doc 是一个面向既有设计文档的更新工作流技能,专门处理 Design Doc、PRD 和 ADR 三类文档的修改,并在修改过程中引入审查与一致性校验环节。它不负责新需求分析、工作规划或实现,也不负责创建新文档。

主要能力

  • 目标文档识别:在 docs/design/、docs/prd/、docs/adr/ 下发现既有文档;若 $ARGUMENTS 指定路径则直接使用,若描述主题则搜索匹配文档,多个候选时通过 AskUserQuestion 呈现选项,未找到则报告并结束。
  • 文档类型与层级判定:按路径模式区分 Design Doc、PRD、ADR;对 Design Doc 和 ADR 进一步判断层级,涉及 React、组件、UI、前端等信号时选用 technical-designer-frontend,其余情况选用 technical-designer。
  • 变更内容澄清:确定需要更新的章节、变更原因和更新后的预期结果,必要时通过 AskUserQuestion 补充未确定项。
  • 文档更新:以 update 模式调用对应更新代理,并追加变更历史条目。
  • 文档审查:Design Doc 更新后先调用 code-verifier 对照当前代码库校验(重点关注路径、端点、类型名、配置键等字面标识符的引用完整性),再调用 document-reviewer;PRD 与 ADR 直接调用 document-reviewer。
  • 一致性验证:Design Doc 额外调用 design-sync 做一致性验证,检测到冲突时按 Review Resolution Gate 处理。
  • 审批门:流程在 [Stop: Final approval] 处停止,等待用户批准后才完成。

使用方式

该技能以编排者(orchestrator)身份运行,按 Step 1 至 Step 6 顺序执行,仅沿文档类型和审查结果激活的分支推进。执行前需先执行 llm-friendly-context 技能(在编写 Agent 提示、交接或生成产物之前)和 subagents-orchestration-guide 技能(在做出工作流决策、调用代理或处理发现之前)。在首次处理审查发现之前,需读取已加载 subagents-orchestration-guide 技能中的 references/review-resolution.md。

更新流程为:识别目标 → 澄清变更 → 更新文档 → 审查 → 一致性检查。调用代理时,提示按机械提取方式构建:将指定来源值复制到对应字段,仅应用声明的序列化,然后立即调用。

审查结果为 Pass 时进入 Step 6;Needs revision 时应用 Review Resolution Gate,存在需应用的发现则返回 Step 4 修订;所有可操作发现均为 decline 时进入 Step 6。

适用场景

  • 需要修改既有 Design Doc、PRD 或 ADR 的内容。
  • 希望文档更新后经过代码校验(Design Doc)和文档审查。
  • 希望 Design Doc 更新后与代码库保持一致。
  • ADR 的小改动(澄清、错别字修正、小范围调整)更新原文件;大改动(决策反转、范围显著变化)创建取代原文件的新 ADR。

限制

  • 不包含新需求分析、工作规划或实现。
  • 不创建新文档;未找到目标文档时报告并结束。
  • 子代理更新失败时记录失败、向用户呈现错误并重试一次。
  • 完成条件是用户批准完成更新。
  • 关于收费、价格、平台支持等具体信息,资料中暂未提供。