Back to catalog

plan-validate-structure

Validate plan directory structure and file format compliance with Template 1 (9-section format). Use before committing plan changes or creating issues.

  • Category: discovered
  • Tags: github, community
  • Version: 1.0.0
  • Author: walid
  • Downloads: 0
  • GitHub stars: 4
  • Updated: 2025-11-21

Download the latest version (v1.0.0) from this page.

SKILL.md

---
name: plan-validate-structure
description: Validate plan directory structure and file format compliance with Template 1 (9-section format). Use before committing plan changes or creating issues.
---

# Plan Structure Validation Skill

Validate plan structure follows Template 1 format.

## When to Use

- After creating new plans
- Before committing plan changes
- Before creating GitHub issues
- Troubleshooting plan errors

## Validation Checks

### 1. Structure

- All 9 sections present
- Sections in correct order
- Proper markdown formatting
- Links use relative paths

### 2. Hierarchy

- Parent/child links valid
- No circular references
- Correct level nesting
- All references exist

### 3. Content

- Title present (# heading)
- Overview not empty
- Steps numbered correctly
- Success criteria have checkboxes

## Usage

```bash
# Validate all plans
./scripts/validate_all_plans.sh

# Validate specific section
./scripts/validate_plans.sh notes/plan/01-foundation

# Validate single plan
./scripts/validate_plan.sh notes/plan/01-foundation/plan.md
```text

## Common Issues

### Missing Sections

```text
❌ Missing section: ## Success Criteria
```text

**Fix:** Add missing section to plan.md

### Invalid Links

```text
❌ Broken link: [../nonexistent.md](../nonexistent.md)
```text

**Fix:** Correct link path or create referenced file

### Wrong Format

```text
❌ Success criteria must use checkboxes (- [ ])
```text

### Fix:

```markdown
## Success Criteria

- [ ] Criterion 1
- [ ] Criterion 2
```text

## Template 1 Format

Required sections:

1. Title (# heading)
1. Overview
1. Parent Plan
1. Child Plans
1. Inputs
1. Outputs
1. Steps
1. Success Criteria
1. Notes

See `phase-plan-generate` skill for complete template.