Step 5 of milestone 415 "An existing plan is found before a new one is made". Sessions opened a second milestone beside the roadmap milestone that already covered the work, and filed related tasks loose, because no surface told them to look first. - writing-plans: a section on finding the plan that exists (enter_project's unplanned_milestones, search(content_type="milestone"), list_milestones); when an active milestone covers the work, add steps to it; a second milestone only for a separate arc; the gate's existing_milestone reply. - using-scribe: "when you plan" gains the same check and milestone_id on related tasks. - _INSTRUCTIONS PLAN line points at the milestone search (1,689 of 2,000). - test_guidance_ownership pins the topic on writing-plans. - Plugin version minted: 2026.09.15.1744. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01821k5B3Ysecp9fNYs92Kuy
6.2 KiB
name, description
| name | description |
|---|---|
| writing-plans | Use when a piece of work has an arc — several steps toward one goal, worth tracking as a unit — and you want the approach reviewable before you start. Triggers when the user asks you to plan, design an approach, or scope an effort, or when work is about to sprawl across several steps. Not for single-step work. The plan lives in a Scribe milestone (via start_planning), not a local file. |
Writing plans
A plan is how you'll execute a chunk of work — the design plus an ordered set of steps — written before you start, so the approach is reviewable and the work stays trackable.
First decide whether this work wants a plan
A plan lives in a milestone, and a milestone earns its place when the work has an arc: several steps, one shared goal, a beginning and an end worth tracking as a unit. That is the whole test, and it is a judgment about the shape of the work — not about its size, difficulty, or importance.
Plenty of real work has no arc. A bug fix, a one-file change, a question
answered, a setting changed. For those, a milestone is a container with one
thing in it: the ceremony costs more than it records, and it leaves the project
with milestones that never meant anything. Use a task instead — set it
in_progress, record what you find with add_task_log, set it done. That is
a complete, honest record of work that didn't need a plan.
Some projects are milestone-shaped and some are a flat task list. Read the project you are in rather than imposing a shape on it.
Then look for the plan that already exists
Before you start a plan, find out whether the project already has one for this work. A roadmap is often written ahead of the work as milestones with a goal and no steps yet, and those are exactly the plans a session misses: they have nothing in them to show up as open tasks.
enter_projectlists the recent milestones and, underunplanned_milestones, the active ones with no steps.search(content_type="milestone", project_id=...)finds a plan by what it is for.list_milestonesreads the whole roadmap.
When an active milestone already covers the work, the plan is that milestone.
Read it with get_milestone, add your steps with
create_records(milestone_id=<its id>, records=[…]), and revise its body with
update_milestone if what you know now changes the design. Opening a new
milestone beside it splits one piece of work across two plans, and neither
shows the whole. A second milestone is right only when the work is a separate
arc: a different goal that would still make sense if the first plan were done.
The same holds for single tasks. Work that belongs to an existing plan is
created with that milestone's milestone_id, not left loose beside it.
start_planning and create_milestone check too. When an active milestone in
the project has the same title or reads as the same plan, they return it as
existing_milestone and create nothing. Add to that plan, or pass force=true
only when you have read it and this really is separate work.
When it does: start the plan in Scribe, not a file
Call start_planning(project_id, title) before designing or implementing —
so the milestone exists to write into, rather than being backfilled from work
already done. It creates a milestone (the plan container) seeded with a
design template and returns the milestone id plus the project's applicable
rules. The plan lives in that milestone:
- The design/intent goes in the milestone
body— pass it asstart_planning(..., body=...), or edit it later withupdate_milestone(milestone_id, body=...). - Each step is its own task under the milestone. When you know the steps,
pass them in the same call —
start_planning(..., steps=[{title, body}, …])— and the milestone and every step are created together. Add steps later withcreate_records(milestone_id=<that milestone>, records=[…]), orcreate_taskfor one. Track each with status +add_task_log. Steps are first-class tasks, not checkboxes in the body. - Read the whole plan back with
get_milestone(body + its step-tasks).
Never write an id you have not been given. A plan body that says "see
#4012" before #4012 exists is a guess, and other sessions and users are
creating records from the same sequence at the same time — the number goes to
whoever creates next, and the plan then points at their record. Scribe refuses
a body citing an id that has not been assigned. Where the plan and its steps
need to cite each other, write a placeholder instead: {{ref:N}} is the Nth
step in the list, {{ref:milestone}} is the milestone. They are replaced with
the real id and title as the records are created.
Do not write plans or specs to local .md files — the milestone is the
record, not a file on disk. (The old kind=plan task is retired; start_planning
no longer creates one.)
Before designing from scratch, recall: search Scribe for a related prior
decision or note. Often the thinking (or half of it) already exists.
What a good plan contains
- Goal — what "done" looks like, and why, in a sentence or two (milestone body).
- Approach — the key design decisions and the trade-offs you chose, briefly (milestone body).
- Steps — an ordered set of step-tasks under the milestone, each small enough to verify on its own; note which files/areas each touches.
- Verification — how you'll know it actually works (a test, CI, an observable behavior), not just "it's written."
While executing
- Keep the plan honest: drive each step-task's status (todo →
in_progress → done) as it lands; record decisions, findings, and pivots with
add_task_logon the relevant step rather than silently rewriting the body. - If reality diverges from the plan, update the milestone body — a design that no longer matches what you're doing is worse than none. Add or re-scope step-tasks as the work changes.
- Mark the milestone
donewhen its steps are complete.
Match depth to the work
A two-step change deserves a two-line plan; a multi-day effort deserves a fleshed-out milestone body and several step-tasks. Don't over-plan the trivial, and don't under-plan something that will sprawl. The point is a shared, reviewable intent — not ceremony.