Skip to content

WIP plan layout (๐Ÿ‘€ scan-first)

Plans with effort tracking follow a fixed scan-first order at the top of the doc. Do not repeat the Fibonacci scale table in the plan โ€” watermark to the plan-effort-estimate skill instead.

Full skeleton: wip-plan-template.md.

Document order

# Plan title

Sub-plan / Status / Owner / Related plans

## ๐Ÿ‘€ {percent}% complete          โ† script: --markdown-top
{effort ยท steps ยท remaining}
Phase rollups: โ€ฆ
[Effort breakdown โ†“](#effort-breakdown) ยท {effort.json} ยท scale watermark
### Phase status                   โ† phase rollup table (in --markdown-top)

## Recent progress ({date})       โ† human-authored; evidence-based
## Goal                             โ† human-authored; one paragraph + scope boundary

โ€ฆ plan body (decisions, architecture, phased delivery, risks, open questions) โ€ฆ

## Effort breakdown                 โ† script: --markdown-breakdown
{watermark to skill + effort.json}
{per-phase step tables}
{phase rollup table โ€” duplicate of top for detail anchor}

## References                      โ† optional; after effort breakdown is OK

What goes where

Section Content Source
Title block # Title, sub-plan link, Status:, Owner: Human-authored
๐Ÿ‘€ top summary Percent, effort done/total, steps done/total, remaining, watermark summarize-effort.mjs --markdown-top
Phase status table Phase | Effort | Done | Left | Progress summarize-effort.mjs --markdown-top (included)
Recent progress Dated changelog; 3โ€“6 bullets max; cite evidence Human-authored
Goal Outcome and scope boundary in one paragraph Human-authored
Plan body Architecture, phased delivery, decisions, risks Human-authored
Effort breakdown Per-step tables with Done / Left columns + phase rollups summarize-effort.mjs --markdown-breakdown
Scale Never inline โ€” link via skill watermark Skill only

Recent progress

  • Heading: ## Recent progress (YYYY-MM-DD) โ€” use today's date when updating.
  • Lead with what was validated or landed, not intentions.
  • Call out still open exit criteria in one line if the active phase is not done.
  • Keep it short โ€” detail belongs in step notes in *.effort.json or the plan body.

Goal

  • One ## Goal section immediately after Recent progress.
  • State the outcome, the primary constraint, and what is explicitly out of scope.
  • Do not duplicate the ๐Ÿ‘€ metrics or phase table here.

Watermark (copy verbatim pattern)

Top (short):

[Effort breakdown โ†“](#effort-breakdown) ยท [`plan.effort.json`](./plan.effort.json) ยท scale: HoEN library **plan-effort-estimate** skill

Breakdown header (one line, italic):

_Sourced from [`plan.effort.json`](./plan.effort.json). Fibonacci scale: HoEN library **plan-effort-estimate** skill. Re-run `summarize-effort.mjs --markdown-breakdown` after updates._

Refresh workflow

  1. Edit *.effort.json beside the plan.
  2. Run --markdown-top โ†’ paste over the ## ๐Ÿ‘€ {percent}% complete block through ### Phase status table.
  3. Update ## Recent progress and ## Goal if needed.
  4. Run --markdown-breakdown โ†’ paste over ## Effort breakdown section.
  5. Do not hand-calculate totals.