Skip to content

Status dashboard and auto roadmap

What it does: Reads specs/INDEX.md and generates a visual Mermaid roadmap.

How to use:

Terminal window
./scripts/generate-roadmap.sh

Output: Creates two files:

  • docs/roadmap.mmd — Raw Mermaid diagram source
  • docs/roadmap.md — Markdown file with embedded Mermaid for GitHub rendering

When to run: After creating new specs or changing priorities in INDEX.


What it does: Evaluates the quality and completeness of your specifications.

How to use:

Terminal window
# Score all specs
./scripts/score-spec.sh --all
# Score a specific spec
./scripts/score-spec.sh specs/001-my-feature

What it checks:

Criterion What it looks for
File completeness All 5 required files present (spec, plan, tasks, research, history)
Content depth Files have meaningful content, not just templates
Acceptance criteria spec.md has clear, testable criteria
Task breakdown tasks.md has checkboxes with specific actions
History tracking history.md has at least one entry

What it does: Creates a new numbered spec folder with all required template files.

How to use:

Terminal window
./scripts/new-spec.sh "feature-name" "OwnerName"

Output: Creates specs/NNN-feature-name/ with pre-filled templates.


flowchart LR
A["Create/Update Specs"] --> B["Score Quality"]
B --> C["Generate Status"]
C --> D["Generate Roadmap"]
D --> E["Update Logbook"]
E --> F["Commit & Push"]
  1. Work on your specs and implementation
  2. Run ./scripts/score-spec.sh --all to check quality
  3. Run ./scripts/generate-status.sh to update the dashboard
  4. Run ./scripts/generate-roadmap.sh if specs changed
  5. Update the logbook and commit
## Active specs
| Number | Name | Status | Priority | Owner |
|--------|-------------|-------------|----------|-------|
| 001 | user-auth | In Progress | High | Juan |
| 002 | dashboard | Draft | Medium | Maria |
## Task progress
- Pending: 12
- Completed: 8
gantt
title Project Roadmap
section Auth
001-user-auth :active, a1, 2026-01-01, 14d
section UI
002-dashboard : a2, after a1, 10d
  • Start from a simple one-paragraph project description.
  • Ask the AI to confirm the active spec before coding.
  • Close every session with validation and a clear next step.
flowchart LR
A["Project idea"] --> B["Spec approved"]
B --> C["Plan aligned"]
C --> D["Tasks prioritized"]
D --> E["Implementation"]
E --> F["Validation + Logbook"]