skills/roadmap-create/SKILL.md
{{ 𝛀𝛀𝛀 }} Create a project roadmap in the rich phase-array format — roadmaps.json as source of truth plus a PHASE task list and prose overview
npx skillsauth add jasonwarrenuk/goblin-mode Roadmap: CreateInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Create a roadmap as three synchronised artefacts:
.claude/roadmaps.json — machine-readable source of truth, an array of phase objects each {name, path, archived?, externalGates, milestones}. The active phase is the entry without archived: true; archived entries are retained as historical record.docs/roadmaps/{PHASE}.md — human-readable task list and dependency diagram (a projection).docs/reports/ROADMAP_OVERVIEW.md — prose overview (a projection).When creating a new phase alongside existing ones, append a new element and mark the superseded phase "archived": true.
Shared conventions (status vocabulary, colour table, graph rules, formatting) live in ~/.claude/library/references/roadmap-conventions.md — read it before writing anything. The CLI is python3 "$HOME"/.claude/library/scripts/roadmap.py.
| Codebase Context | Arguments Passed | Action |
| ----------------- | ---------------- | --------------------------------------------------------- |
| No other roadmaps | 0 | Create the first project roadmap (default PHASE_1.md) |
| N/A | 1 | Create the roadmap/phase named in the argument |
| Roadmaps exist | 0 | Ask the user which phase to create or if starting a new phase |
docs/roadmaps/ exists and contains roadmaps; check if .claude/roadmaps.json exists.$ARGUMENTS is given, use it as the phase name (e.g. PHASE_2). If no arguments and no existing roadmap, default to PHASE_1. If no arguments but roadmaps exist, ask the user to clarify intent.python3 "$HOME"/.claude/library/scripts/roadmap.py detect. Exit 3 = old simple format: stop and tell the user to run the roadmap-migrate skill first, so the new phase is appended to a consistent phase array. Exit 2 = could not locate/parse: ask the user for the path. Only proceed on exit 0 (or when no roadmap exists yet).Read what is available to understand the project: README.md, CLAUDE.md, docs/ (architecture, proposals, ADRs), and any existing roadmaps in docs/roadmaps/.
Ask targeted questions before generating anything (2–3 per round, not a long form):
EV = evaluation, IN = ingestion, SR = search).Format: {MilestoneNum}{Category}.{Seq} — e.g. 1EV.1, 3IN.6. Sub-tasks use an alpha suffix: 3IN.2a. Never reuse an ID; number sequentially within each category; new tasks append (never renumber).
The mechanical status rule from the conventions reference applies: empty dependsOn → todo; any non-done dependency → blocked. No task starts done unless the user says the work is already complete. paused/deferred are only for tasks parked behind a gate or a later phase. softDependsOn never feeds this rule.
.claude/roadmaps.jsonThe top level is an array of phase objects. Append + archive the superseded phase if others exist; otherwise write a one-element array. Tabs for indentation, British spelling.
[
{
"name": "{Phase Name}",
"path": "docs/roadmaps/{PHASE}.md",
"archived": false,
"externalGates": [],
"milestones": [
{
"id": "M{N}",
"name": "{Milestone Name}",
"goal": "{One-sentence objective}",
"tasks": [
{ "id": "{ID}", "description": "{Task description}", "status": "todo", "dependsOn": [] }
]
}
]
}
]
id, description, status, dependsOn, softDependsOn, iterative, notes, assignee; gates: id, name, status, imposes, blocks, notes. Include softDependsOn/notes/iterative/assignee only when meaningful — assignee is free-text with no roster, and must never be guessed.externalGates, per phase, beside milestones) model things outside the team's control that block work: {id, name, status:"external", imposes?, blocks[], notes?}. imposes (default blocked; may be paused or deferred) is the status the gate forces on its blocked children; blocks[] is the reverse edge — every task ID that lists this gate in its dependsOn. A gate ID can appear in a task's dependsOn.dependsOn entry may be a milestone ID (M1, MP…): it resolves done only when every task in that milestone is done.iterative: true flag marks a task that loops to convergence — descriptive only, never a cyclic dependsOn.softDependsOn entry authors an optional, best-effort link that renders dotted in the diagram (X -.-> Y) but imposes no status, no cycle constraint, and no sink effect (full semantics in the conventions reference). Use it for relationships worth showing but not worth blocking on — never hand-draw a dotted line into the generated diagram instead.docs/roadmaps/{PHASE}.md# {Project Name} {Phase} Roadmap
{1–3 sentence intro.}
**Critical path:** `{key IDs in sequence}` — {brief explanation}.
---
## Milestone 1 — {Name}
**Goal:** {Milestone objective}
- [ ] **{ID}** — {description}
- [ ] **{ID}** — {description} _(depends on {ID})_
- [ ] **{ID}** — {description} _(blocked — depends on {ID}, {ID})_
- Note: {optional note}
---
## Dependency Diagram
```mermaid
{output of roadmap.py graph --mermaid}
```
Task line annotations follow the conventions reference (none / _(depends on {IDs})_ / _(blocked — depends on {IDs})_ / _(paused — reconvene {gateId})_ / _(deferred to a later phase)_).
The diagram is generated, never hand-written. Once the JSON is written, run:
python3 "$HOME"/.claude/library/scripts/roadmap.py graph --mermaid --direction LR
and paste the output verbatim into the fenced mermaid block. It emits the classDefs (canonical status colours), nodes, edges (terminal milestone convention) and class statements in the right order. Do not add, remove or recolour lines by hand.
docs/reports/ROADMAP_OVERVIEW.md# {Project} {Phase}: Roadmap Overview
**{N} tasks across {M} milestones.** Files: `.claude/roadmaps.json` (machine-readable), `docs/roadmaps/{PHASE}.md` (full task list with Mermaid dependency diagram).
> {Rescope/context note if relevant}
---
## What we're building
{2–3 paragraphs on the key deliverables and the reasoning behind the phase structure.}
## Milestone sequence and the reasoning behind it
{One paragraph per milestone.}
## Decisions that shaped the structure
{Key decisions that explain non-obvious choices.}
## External blockers (flag early)
{Dependencies on external parties, unconfirmed decisions, etc.}
The header task count must match roadmaps.json. Get it from python3 "$HOME"/.claude/library/scripts/roadmap.py stats rather than counting by hand.
python3 "$HOME"/.claude/library/scripts/roadmap.py validate — it must report clean (dependsOn/blocks parity, acyclicity, status recompute). Fix any discrepancy before finishing.roadmap.py stats), and the status breakdown.{MilestoneNum}{Category}.{Seq}; never reuse IDs.~/.claude/library/references/roadmap-conventions.md.These roadmaps are maintained by roadmap-maintain (status synchronisation) and roadmap-update-tasks (adding tasks). Old simple-format roadmaps are upgraded by roadmap-migrate; the HTML dashboard comes from artefact-roadmap (roadmap.py render).
tools
{{ 𝚫𝚫𝚫 }} Rebuild roadmap-system.zip, the distributable snapshot of the roadmap tooling (scripts, HTML template, conventions reference, and every roadmap-touching skill, including this one).
tools
--- name: "Suggest: Task" description: "{{ 𝚫𝚫𝚫 }} Suggest the next logical task — grounded in the roadmap's pre-vetted ready-set when one exists, codebase analysis otherwise" when_to_use: "When you don't know what to work on next and want a grounded recommendation rather than picking arbitrarily." model: haiku effort: low disable-model-invocation: true allowed-tools: ["Read", "Glob", "Grep", "Bash(python3:*)", "Bash(npm:*)", "Bash(bun:*)", "Bash(pnpm:*)", "Bash(deno:*)"] argument-hint: [named
development
{{ 𝛀𝛀𝛀 }} Convert an old simple-style roadmap (single Markdown, four statuses, <a name> anchors, roadmaps.json pointer registry) into the rich phase-array format (roadmaps.json source of truth + PHASE task list + prose overview).
data-ai
{{ ƔƔƔ }} Create a pull request to main — wordy or shiny (with screenshots), ready-for-review or draft