mcpField
D
docs-workflow-bootstrap

docs-workflow-bootstrap

github.com/adol1111Agent 工作流056 次安装14 周前更新
代码仓库

关于 docs-workflow-bootstrap

用于为尚未准备好文档驱动工作流的代码库创建最小文档入口框架。它只补建缺失的导航文件,随后暂停以供审查。

主要功能

  1. 01检测缺失的框架文件
  2. 02仅创建缺失的入口文档
  3. 03保持文档精简
  4. 04暂停并等待审查与交接

适用场景

  1. 01初始化代码库以开展文档驱动工作
  2. 02补回缺失的文档入口

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/adol1111/doc-driven-spec-workflow --skill docs-workflow-bootstrap

安装后在 Claude Code 中输入/docs-workflow-bootstrap确认已加载。

附带文件agents/openai.yamlreferences/scaffold-template.md

详细介绍

文档工作流引导初始化

目的

创建最精简的工作流脚手架,让后续阶段有权威文档可供查阅。

适用情形

  • 缺少一个或多个最精简的脚手架文件
  • 仓库尚未初始化为此文档驱动工作流
  • 基础文档入口尚不存在,导致后续阶段无法恢复状态

不适用情形

  • 最精简的脚手架已经存在
  • 当前工作是路线图拆解、任务级设计或执行
  • 用户希望在引导初始化期间创建实施任务、规范、计划或代码变更

首先阅读

  • 现有的 docs/ 文件(如有)
  • 仓库中的文档语言线索(如有)
  • 当前用户提示

负责范围

  • 检测最精简的脚手架
  • 创建最精简的工作流入口文档
  • 仅在用户于引导初始化期间明确要求时,简要记录规划收件箱中的目标
  • 暂停进行引导初始化评审并建议后续交接

不负责范围

  • 里程碑拆解
  • 创建实施任务
  • 任务级 spec.md 或 plan.md
  • 实施或分支工作流
  • 在脚手架文档中填入过多路线图或执行细节

入口检查

仅创建以下缺失文件:

  • 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,由其选择下一阶段
  • 仅当用户明确要求走该路径时,才直接继续到另一阶段。

输出

  • 已创建的文件
  • 已更改的文件
  • 保留的规划收件箱目标背景(如有)
  • 建议的下一个技能

停止点

  • 暂停进行引导初始化评审

交接

  • Decided
  • Undecided
  • Next skill
  • Stop point

参考资料

  • 使用 references/scaffold-template.md 了解最精简脚手架文档的结构。

评论

支持 Markdown