SuperAPI AI 工具集

docs-workflow-bootstrap

写作与研究

查看项目

更新于 10-15 11:06

技能介绍

用途

docs-workflow-bootstrap 用于为仓库创建最小化的文档驱动工作流脚手架,使后续阶段能够读取到权威的文档入口。它适用于以下情况:一个或多个最小脚手架文件缺失;仓库尚未针对该文档驱动工作流进行初始化;由于基本文档入口点尚不存在,后续阶段无法恢复状态。

不适用的情况包括:最小脚手架已存在;当前工作是路线图分解、任务本地设计或执行;用户在引导期间想要实现任务、规格、计划或代码更改。

主要能力

该技能负责最小脚手架的检测,以及最小工作流入口点文档的创建。仅在引导期间被明确要求时,才会进行紧凑的规划收件箱目标捕获。它还负责引导审查暂停和交接建议。

它不负责里程碑分解、实现任务创建、任务本地 spec.md 或 plan.md、实现或分支工作流,也不会用路线图或执行细节过度填充脚手架文档。

使用方式

首先阅读现有的 docs/ 文件(如有)、仓库文档语言线索(如有)以及当前用户提示。

入口检查:仅在缺失时创建以下文件:

  • docs/index.md
  • docs/architecture/index.md
  • docs/tasks/index.md
  • docs/tasks/planning-inbox.md
  • docs/tasks/backlog.md
  • docs/context/index.md

使用仓库文档语言规则(如可用),否则遵循当前用户语言。

默认流程:

  1. 检测哪些最小脚手架文件缺失。
  2. 仅创建缺失的工作流入口点。
  3. 保持内容最小化和导航性。
  4. 如果用户在引导期间明确要求保留类似路线图的输入,仅将其记录为紧凑的规划收件箱目标上下文。
  5. 在报告创建或更改的文件后,停在引导审查暂停点。

边界规则:引导仅涉及文档治理。默认不创建里程碑、模块、任务、spec.md、plan.md、docs/specs/ 或 docs/plans/。引导期间不将宽泛的用户需求转化为任务分解。planning-inbox.md 可以捕获紧凑的目标上下文,但不是里程碑分解。保持脚手架文档足够小,以便后续阶段可以在无需清理工作的情况下重塑它们。

如果受阻:如果最小脚手架存在但下一阶段不明确,交回 doc-driven-spec-workflow。如果用户在引导期间要求路线图规划,先完成最小脚手架,然后建议 milestone-planning。如果用户在引导期间要求具体任务执行,不要直接跳到那里,除非仓库已有确认的路线图状态。

审查与后续:在报告创建或更改的文件后,停在引导审查暂停点。将审查暂停后明确的向前推进语言视为常规后续操作的许可。审查后的默认后续操作是:提交已审查的脚手架文档(除非用户明确要求保持未提交),然后返回 doc-driven-spec-workflow,以便路由选择下一阶段。仅在用户明确要求该路径时,才直接继续到另一阶段。

适用场景

适用于需要初始化文档驱动工作流的仓库,尤其是当后续阶段因缺少基本文档入口点而无法恢复状态时。也适用于需要为文档治理建立最小基础结构的场景。

限制

该技能仅创建最小脚手架,不进行里程碑分解、任务创建或实现工作。它不会在引导期间生成 spec.md、plan.md 或任务分解。内容保持最小化,避免过度填充。如果用户要求路线图规划或任务执行,需要先完成引导,再建议或交接到相应阶段。

输出

输出包括:创建的文件、更改的文件、保留的规划收件箱目标上下文(如有)、推荐的下一技能。

停止点:引导审查暂停。

交接:已决定、未决定、下一技能、停止点。

参考:使用 references/scaffold-template.md 获取最小脚手架文档形状。