mcpField
P
planning-validate

planning-validate

github.com/drillan测试与质量362 次安装40 周前更新
代码仓库

关于 planning-validate

planning-validate 是在 /speckit.plan 完成后、生成任务前检查规划文档的技能。它评估必需章节、内容一致性、接口契约和章程合规性,并给出 GREEN、YELLOW 或 RED 结果。

主要功能

  1. 01检查 spec.md 必需章节
  2. 02评估 plan.md 的可执行性
  3. 03核对 data-model.md 实体与规格
  4. 04检查 API 契约覆盖情况
  5. 05评估章程合规性
  6. 06报告 GREEN、YELLOW 或 RED

适用场景

  1. 01在 /speckit.plan 后验证文档
  2. 02在生成任务前发现缺漏
  3. 03检查实体与接口契约的一致性
  4. 04识别规划文档中的阻塞项

安装

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

$npx skills add https://github.com/drillan/speckit-gates --skill planning-validate

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

附带文件scripts/validate.sh

详细介绍

planning-validate

在 /speckit.plan 完成后,验证规划制品的质量和一致性。

目的

此技能会自动验证你的规划制品,在生成任务前发现规范中的缺漏。它会检查:

  • spec.md 完整性:所有必需章节均存在且包含内容
  • plan.md 可执行性:技术上下文、项目结构和章程检查均已完成
  • data-model.md 一致性:实体与规范要求一致(如果存在)
  • 契约覆盖率:为必需端点定义了 API 契约(如果存在 contracts/)
  • 章程合规性:计划遵循项目章程规则(如果存在 constitution.md)

输出

此技能会输出质量评估,包括:

  • GREEN:所有检查均通过——继续执行 /speckit.tasks
  • YELLOW:存在轻微警告——请检查,但可以继续
  • RED:发现阻塞问题——必须先解决才能继续

用法

此技能会在 /speckit.plan 之后自动运行。你也可以手动运行:

npx skills run planning-validate

退出代码

代码状态含义
0GREEN所有检查均通过
1YELLOW存在警告
2RED存在阻塞问题
3Error缺少必需文件

执行的检查

spec.md 检查
  1. 文件存在且可读
  2. Summary 章节存在且包含内容
  3. User Stories 章节存在且至少包含一个故事
  4. Functional Requirements 章节存在且包含 FR-XXX 条目
  5. Success Criteria 章节存在
plan.md 检查
  1. 文件存在且可读
  2. Technical Context 章节存在
  3. Project Structure 章节存在
  4. Constitution Check 章节存在(除非已跳过)
  5. Gate Result 显示 PASS 状态
data-model.md 检查(如果存在)
  1. Entities 章节存在
  2. 至少定义了一个实体
  3. 实体名称与 spec.md 中的术语一致
contracts/ 检查(如果存在)
  1. 至少存在一个契约文件
  2. 契约文件是有效的 Markdown
  3. 契约端点与 spec.md 要求一致
constitution.md 检查(如果存在)
  1. plan.md 引用了章程原则
  2. Gate Result 中没有违反章程的情况

阻塞问题示例

  • “spec.md:缺少 User Stories 章节”
  • “plan.md:Constitution Check 章节显示 FAIL 状态”
  • “data-model.md:实体 ‘UserAccount’ 未在 spec.md 中引用”

建议

收到 RED 或 YELLOW 状态后:

  1. 检查列出的具体阻塞问题或警告
  2. 更新受影响的制品以解决问题
  3. 重新运行 /speckit.plan 以重新生成 plan.md
  4. 再次运行 planning-validate 以验证修复结果

评论

支持 Markdown