mcpField
D
doc-flow

doc-flow

github.com/vladm3105Agent 工作流1765 次安装1 天前更新
代码仓库

关于 doc-flow

用于规范驱动开发(SDD)的流程路由技能,帮助团队选择对应技能、查看项目进度并遵守上游文档要求。它不创建文档,而是依据八层流程和项目配置引导后续步骤。

主要功能

  1. 01将任务路由到对应文档技能
  2. 02扫描文档并报告流程位置与进度
  3. 03检查模板必需章节并报告缺项
  4. 04按依赖关系推荐下一步及并行工作
  5. 05落实上游文档与变更管理规则
  6. 06支持项目配置中的启用层级

适用场景

  1. 01不确定应使用哪项文档技能时
  2. 02检查 SDD 项目当前阶段与下一步
  3. 03发现文档缺少模板规定章节时
  4. 04在已有项目中规划后续文档工作

安装

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

$npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-flow

安装后在 Claude Code 中输入/doc-flow确认已加载。

详细介绍

doc-flow

用途

路由 规范驱动开发(SDD)工作流:根据任务指向合适的技能、报告当前进度,并强制执行上游制品策略。doc-flow 本身不会创建制品——这由制品技能完成。

层级:跨层(无上游;可路由至全部 8 层)。 权威规范:${CLAUDE_PLUGIN_ROOT}/framework/SPEC_DRIVEN_DEVELOPMENT_GUIDE.md。

适用场景

情况操作
不确定该使用哪个技能使用 doc-flow(本技能)
全新项目先使用 ../project-init/SKILL.md,然后使用 doc-flow
将 SDD 引入现有代码先使用 ../project-adopt/SKILL.md
编辑已发布的制品使用 ../doc-chg/SKILL.md——不要走线性流程
端到端生成单个层级的内容使用该层级的 -autopilot

8 层工作流

BRD (1) → PRD (2) → EARS (3) → BDD (4) → ADR (5) → SPEC (6) → TDD (7) → IPLAN (8) → Code
层级制品用途基础技能
1BRD业务需求doc-brd
2PRD产品需求与 KPIdoc-prd
3EARS正式的 WHEN-THE-SHALL 需求doc-ears
4BDDGherkin 测试场景doc-bdd
5ADR架构决策doc-adr
6SPEC技术规范doc-spec
7TDD测试用例定义与阈值doc-tdd
8IPLAN可执行的实施计划doc-iplan

每个层级提供 四种 技能:基础技能(创建)、-autopilot(端到端)、-audit(门禁报告)、-fixer(应用审计修复)。

技能选择

已有内容所需内容使用
无业务需求doc-brd
BRD产品需求doc-prd
PRD正式需求doc-ears
EARS测试场景doc-bdd
BDD架构决策doc-adr
ADR技术规范doc-spec
SPEC测试用例定义doc-tdd
TDD实施计划doc-iplan
IPLAN代码实施
任一阶段补充文档doc-ref

意图 → 技能(层级明确时,根据动词选择):

操作技能
创建 / 起草该层级的基础技能或 -autopilot
审计 / 评分该层级的 -audit
修复 / 补救该层级的 -fixer
验证 / 追踪 / 链接 / 孤项../doc-validator/SKILL.md
更改已发布的制品../doc-chg/SKILL.md + ../gate-check/SKILL.md
路线图 / 分阶段../adr-roadmap/SKILL.md
搭建脚手架 / 新项目../project-init/SKILL.md
采用 / 棕地项目../project-adopt/SKILL.md
定制 / 配置档案../project-profile/SKILL.md
安全 / 威胁../security-audit/SKILL.md

用户指定某个技能时,直接运行该技能。

当前进度与下一步

当前进度。 扫描 docs/<NN>_<X>/ 中的工件;读取每个文档控制信息中的 Status(大多数层级为 Draft → In Review → Approved;IPLAN 为 Draft → In Progress → Completed)。映射到项目的活跃层级(见 Adaptation);报告当前位置和进度 = 终态状态工件数 ÷ 活跃层级数。

模板符合性检查(必须执行)。 对找到的每个工件,加载 ${CLAUDE_PLUGIN_ROOT}/framework/layers/<NN>_<X>/<TYPE>-TEMPLATE.yaml,并验证每个必需的顶层章节都以 ## 标题的形式出现。将缺失章节报告为偏差发现(无论 Status 如何),例如 “BRD-01 缺少 18 个必需章节中的 6 个:……”。不要将偏差解释为“精简”变体、“有文档记录的演练”或“lint 固定”例外——只有一份模板、一份规范章节列表。Lint 通过仅代表结构子集符合要求,并不代表完全符合模板。建议使用 doc-<layer>-fixer(如需重写,则使用 -autopilot)来弥补差距。

下一步。 根据累积链推荐下一个工件(每个层级都需要其前置条件)。优先级如下:

  • P0 — 缺少必需的上游工件,或关键路径主干上的下一步。
  • P1 — P0 不再受阻后,下一个已就绪的层级。
  • P2 — 可选/并行工作(额外 ADR、doc-ref 补充材料)。

指出并行工作机会(没有共同前置条件的独立轨道);为每项注明要运行的技能。

上下文扫描(撰写前)。 按直接相关性、主题匹配度、时效性和 Approved 状态,对目标类型的候选上游文档进行排序;收集项目词汇(标题、章节标题、术语表),让新文档沿用真实 ID 和一致术语。

实用技能

技能用途
../project-init/SKILL.md搭建新项目(任何层级之前运行)
../project-adopt/SKILL.md将 SDD 应用于现有代码库(棕地项目)
../project-profile/SKILL.md定制工作流(可选;设置 .aidoc/profile.yaml)
../doc-naming/SKILL.mdID/命名规范(TYPE-NN、TYPE.NN.SS.xxxx)
../doc-ref/SKILL.md自由格式参考文档(BRD-REF / ADR-REF)
../doc-validator/SKILL.md跨文档验证 + 双向可追溯性 + 文本审查
../review-team/SKILL.md用于审计/修复器/自动驾驶模式的多角色审查模式
../quality-advisor/SKILL.md针对单份文档的实时撰写指导
../charts-flow/SKILL.mdMermaid 图表和文件管理
../adr-roadmap/SKILL.md根据 ADR 制定实施路线图
../security-audit/SKILL.md安全审查(OWASP/CWE、STRIDE)

变更管理

对已发布工件的变更使用 CHG 覆盖流程,而非线性流程。../doc-chg/SKILL.md(及 -autopilot / -audit / -fixer)对变更进行分类(C1–C3 / Emergency),并将其路由到相应关卡;../gate-check/SKILL.md 运行关卡(GATE-01/03/06/08/CODE,或针对 framework/ 规范变更的 GATE-SPEC),并准备签核表单。由人工批准——技能不会自行批准。

上游工件政策

不要编造缺失的上游工件。每个工件都必须追溯到真实的业务/产品依据。

情况操作
上游工件存在使用其准确 ID 进行引用
缺少必需的上游工件跳过;报告;建议先创建
缺少可选的上游工件在标签中使用 null
不适用省略标签

验证模型

每项技能本身就是验证器(没有运行时代码)。每创建一个工件后,运行该层级的 -audit;继续之前,确认累积的上游标签均已存在(PRD→1 … IPLAN→7)。

适配

阅读 .aidoc/profile.yaml。遵守 active_layers:已禁用的可跳过层(BDD / ADR)不纳入关键路径、进度分母和下一步建议。忽略未知键;如果没有配置文件,则使用完整的 8 层流程。 权威依据:${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md。

阅读捆绑文件

技能路径使用 ${CLAUDE_PLUGIN_ROOT}/framework/…。CLAUDE_PLUGIN_ROOT 是 Claude Code 在安装时设置的环境变量,不是实际文件夹名称。在 shell 中,它会展开(cat "$CLAUDE_PLUGIN_ROOT/framework/…");如果未设置,framework/ 捆绑包会与 skills/ 一起位于插件根目录下。 切勿打开字面文本 ${CLAUDE_PLUGIN_ROOT}。

相关资源

  • 规范指南:${CLAUDE_PLUGIN_ROOT}/framework/SPEC_DRIVEN_DEVELOPMENT_GUIDE.md
  • 层注册表:${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml
  • ID 标准:${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  • 可追溯性:${CLAUDE_PLUGIN_ROOT}/framework/governance/TRACEABILITY.md
  • 治理核心:${CLAUDE_PLUGIN_ROOT}/framework/governance/DOC_GOVERNANCE_CORE.md
  • 编写风格:${CLAUDE_PLUGIN_ROOT}/framework/governance/AUTHORING_STYLE.md
  • 各层指南:${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/README.md

评论

支持 Markdown