Back to Details

planning-validate

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

planning-validate

planning-validate

Validates planning artifacts for quality and consistency after 
/speckit.plan
completes.
在
/speckit.plan
完成后，验证规划工件的质量与一致性。

Purpose

用途

This skill automatically validates your planning artifacts to catch specification gaps before task generation. It checks:
  • spec.md completeness: All mandatory sections present with content
  • plan.md executability: Technical context, project structure, and constitution check completed
  • data-model.md consistency: Entities align with spec requirements (if exists)
  • Contract coverage: API contracts defined for required endpoints (if contracts/ exists)
  • Constitution compliance: Plan follows project constitution rules (if constitution.md exists)
本Skill会自动验证你的规划工件，以便在生成任务前发现规格缺口。它会检查：
  • spec.md 完整性：所有必填章节均已存在且包含内容
  • plan.md 可执行性：技术背景、项目结构以及合规性检查已完成
  • data-model.md 一致性：实体与规格要求一致（若文件存在）
  • 契约覆盖度：已为所需端点定义API契约（若contracts/目录存在）
  • 合规性：计划遵循项目章程规则（若constitution.md存在）

Output

输出

The skill outputs a Quality Assessment with:
  • GREEN: All checks pass - proceed to 
    /speckit.tasks
  • YELLOW: Minor warnings - review but can proceed
  • RED: Blockers found - must resolve before proceeding
本Skill会输出一份质量评估报告，包含：
  • GREEN（绿色）：所有检查通过 - 可继续执行
    /speckit.tasks
  • YELLOW（黄色）：存在轻微警告 - 需检查但可继续执行
  • RED（红色）：发现阻塞问题 - 解决后方可继续

Usage

使用方法

This skill runs automatically after 
/speckit.plan
. You can also run it manually:
bash
npx skills run planning-validate
本Skill会在
/speckit.plan
完成后自动运行。你也可以手动运行：
bash
npx skills run planning-validate

Exit Codes

退出码

CodeStatusMeaning
0GREENAll checks pass
1YELLOWWarnings present
2REDBlockers present
3ErrorRequired files missing
代码状态含义
0GREEN所有检查通过
1YELLOW存在警告
2RED存在阻塞问题
3Error缺失必要文件

Checks Performed

执行的检查项

spec.md Checks

spec.md 检查

  1. File exists and is readable
  2. Summary section present with content
  3. User Stories section present with at least one story
  4. Functional Requirements section present with FR-XXX items
  5. Success Criteria section present
  1. 文件存在且可读
  2. 摘要章节已存在且包含内容
  3. 用户故事章节已存在且至少包含一个故事
  4. 功能需求章节已存在且包含FR-XXX格式的条目
  5. 成功标准章节已存在

plan.md Checks

plan.md 检查

  1. File exists and is readable
  2. Technical Context section present
  3. Project Structure section present
  4. Constitution Check section present (unless skipped)
  5. Gate Result shows PASS status
  1. 文件存在且可读
  2. 技术背景章节已存在
  3. 项目结构章节已存在
  4. 合规性检查章节已存在（除非已跳过）
  5. 网关结果显示PASS状态

data-model.md Checks (if exists)

data-model.md 检查（若文件存在）

  1. Entities section present
  2. At least one entity defined
  3. Entity names are consistent with spec.md terminology
  1. 实体章节已存在
  2. 至少定义了一个实体
  3. 实体名称与spec.md中的术语一致

contracts/ Checks (if exists)

contracts/ 检查（若目录存在）

  1. At least one contract file present
  2. Contract files are valid markdown
  3. Contract endpoints match spec.md requirements
  1. 至少存在一个契约文件
  2. 契约文件为有效的markdown格式
  3. 契约端点与spec.md中的要求匹配

constitution.md Checks (if exists)

constitution.md 检查（若文件存在）

  1. Plan.md references constitution principles
  2. No constitution violations in Gate Result
  1. plan.md中引用了章程原则
  2. 网关结果中无章程违规记录

Blocker Examples

阻塞问题示例

  • "spec.md: Missing User Stories section"
  • "plan.md: Constitution Check section shows FAIL status"
  • "data-model.md: Entity 'UserAccount' not referenced in spec.md"
  • "spec.md: 缺失用户故事章节"
  • "plan.md: 合规性检查章节显示FAIL状态"
  • "data-model.md: 实体'UserAccount'未在spec.md中提及"

Recommendations

建议

After receiving a RED or YELLOW status:
  1. Review the specific blockers or warnings listed
  2. Update the affected artifacts to address issues
  3. Re-run 
    /speckit.plan
    to regenerate plan.md
  4. Run 
    planning-validate
    again to verify fixes
收到RED或YELLOW状态后：
  1. 查看列出的具体阻塞问题或警告
  2. 更新受影响的工件以解决问题
  3. 重新运行
    /speckit.plan
    以重新生成plan.md
  4. 再次运行
    planning-validate
    以验证修复效果