Scrum4Me/docs/plans/archive/2026-04-27-insert-milestone-tool.md
Janpeter Visser 7e45bbdbc0
docs: AI-optimized docs restructure (Phases 1–8) (#61)
* docs(dialog-pattern): add generic entity-dialog spec

Introduceert docs/patterns/dialog.md als bron-of-truth voor elke
create/edit/detail-dialog in Scrum4Me, ongeacht het achterliggende
dataobject. Bevat 14 secties: uitgangspunten, stack, component-
architectuur, layout, validatie, drielaagse demo-policy, submission,
dialog-gedrag, theming, footer, triggers/URL-state, per-entiteit
profile-template, out-of-scope, en een verificatie-checklist.

Registreert het patroon in CLAUDE.md "Implementatiepatronen"-tabel
zodat Claude (en mensen) de spec verplicht raadplegen voor elke
nieuwe dialog.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(dialog-pattern): convert task spec + add pbi/story entity-profiles

Reduceert docs/scrum4me-task-dialog.md van 507 naar ~140 regels: alle
gedeelde regels verhuisd naar docs/patterns/dialog.md, dit document
bevat nu alleen Task-specifieke velden, URL-pattern, status-veld,
server actions, triggers en bewuste out-of-scope-keuzes.

Voegt twee nieuwe entity-profielen toe voor bestaande dialogen:
- docs/scrum4me-pbi-dialog.md (PbiDialog: state-based, code+title-rij,
  PbiStatusSelect, geen delete in v1)
- docs/scrum4me-story-dialog.md (StoryDialog: state-based, header met
  status/priority badges, inline activity-log, demo-readonly-fallback,
  inline-delete-confirm i.p.v. AlertDialog)

Beide profielen documenteren expliciet de "Bekende gaps t.o.v.
generieke spec" zodat opvolgende PR's de afwijkingen kunnen
rechtzetten of bewust kunnen accorderen.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Added pdevelopment docs

* docs(plans): add docs-restructure plan for AI-optimized lookup

Audit of existing 39 doc files (~10.700 lines) and a phased restructure
proposal aimed at minimising the tokens an AI agent has to read to find
the right reference. Captures resolved decisions on language (English),
ADR template (Nygard default with MADR escape-hatch), index generator
(node script), and folder taxonomy. Proposal status — fase 1 to follow.

* docs(adr): add ADR scaffolding (templates, README, meta-ADR)

Set up docs/adr/ as the canonical home for architecture decisions:

- templates/nygard.md — default four-section format (Status, Context,
  Decision, Consequences) for one-way-door decisions.
- templates/madr.md — MADR v4 with YAML front-matter and explicit
  Considered Options for decisions where rejected alternatives matter.
- README.md — naming convention (NNNN-kebab-case), template-selection
  guidance (Nygard default; MADR for auth, queue mechanics, agent
  integration), status lifecycle, and ADR roster.
- 0000-record-architecture-decisions.md — meta-ADR establishing the
  practice itself, in Nygard format.

Backfilling existing implicit decisions (base-ui-over-radix, float
sort_order, demo-user three-layer policy, etc.) is fase 6 of the
docs-restructure plan.

* feat(docs): add docs index generator + initial INDEX.md

scripts/generate-docs-index.mjs walks docs/**/*.md, parses YAML
front-matter (or first H1 fallback) and a Nygard-style ## Status
section, then writes docs/INDEX.md with grouped tables for ADRs,
Specs, Plans (with archive subsection), Patterns, and Other.

Pure Node 20 (no external deps); idempotent — running it twice
produces byte-identical output. Excludes adr/templates/, the ADR
README, INDEX.md itself, and any *_*.md sidecar file.

Wire-up:
- package.json: docs:index → node scripts/generate-docs-index.mjs

Initial run indexed 35 docs across the existing structure; the
generated INDEX.md is committed so the table is reviewable in the
PR before hooking generation into a pre-commit step.

* chore: ignore Obsidian vault and personal sidecar files

Add .obsidian/ (Obsidian vault config) and _*.md (personal sidecar
notes) to .gitignore so the docs/ tree can serve as canonical source
of truth while still being usable as an Obsidian vault for personal
authoring. The docs index generator already excludes the same _*.md
pattern from INDEX.md.

* docs(plans): add PBI bulk-create spec for docs-restructure

Machine-parseable spec for an executor that calls the scrum4me MCP
(create_pbi → create_story → create_task) to seed the docs-restructure
work into the DB.

- Section 1 (Context) is the PBI description; serves as task-context
  via mcp__scrum4me__get_claude_context.
- Section 2 lists the 6 resolved decisions (English, MD3+styling
  merged, solo-paneel merged, .Plans archived, Nygard ADR default,
  node index script).
- Section 3 records what already shipped on this branch so the
  executor doesn't duplicate the ADR scaffolding or index generator.
- Section 4 carries the structured YAML graph: 1 PBI, 8 stories
  (one per phase), 39 tasks. product_id is REPLACE_ME — fill before
  running.
- YAML validated with PyYAML; field schema sanity-checked.

* docs(junk-cleanup): remove stub patterns/test.md

* docs(junk-cleanup): archive .Plans/ to docs/plans/archive/

* docs(front-matter): add YAML front-matter to docs/ root

* docs(front-matter): add YAML front-matter to patterns/

* docs(front-matter): add YAML front-matter to plans + agent files

* docs(index): regenerate INDEX.md after front-matter pass

* docs(naming): drop scrum4me- prefix from doc filenames

* docs(naming): lowercase API.md and MD3 filenames

* docs(naming): rename plan file to kebab-case ASCII

* docs(naming): rename middleware.md to proxy.md (next 16)

* docs(naming): polish CLAUDE.md doc-index after renames

* docs(taxonomy): scaffold topical folders under docs/

* docs(taxonomy): move spec files into docs/specs/

* docs(taxonomy): move design/api/qa/backlog/assets into folders

* docs(taxonomy): move agent-instruction-audit into decisions/

* docs(split): break architecture.md into 6 topical files

* docs(split): merge solo-paneel-spec into specs/functional.md

* docs(split): merge md3-color-scheme into design/styling

* docs(trim): extract branch/commit rules into runbook

* docs(trim): extract MCP integration into runbook

* docs(adr): add 0001-base-ui-over-radix

* docs(adr): add 0002-float-sort-order

* docs(adr): add 0003-one-branch-per-milestone

* docs(adr): add 0004-status-enum-mapping

* docs(adr): add 0005-iron-session-over-nextauth

* docs(adr): add 0006-demo-user-three-layer-policy

* docs(adr): add 0007-claude-question-channel-design

* docs(adr): add 0008-agent-instructions-in-claude-md + update README index

* docs(index): regenerate after ADR 0001-0008

* docs(glossary): add docs/glossary.md

* chore(docs): regenerate INDEX.md in pre-commit hook

* docs(readme): link INDEX + glossary + agent instructions

* feat(docs): add doc-link checker script

* chore(docs): wire docs:check-links and docs npm scripts

* ci(docs): block merge on broken doc links

* docs(links): fix broken cross-references after restructure

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 03:21:59 +02:00

5.2 KiB

title status audience language last_updated applies_to
Herbruikbaar scripts/insert-milestone.ts done
maintainer
contributor
nl 2026-05-03

Plan: herbruikbaar scripts/insert-milestone.ts

Doel

Eén commando dat een specifieke milestone (PBI + stories + tasks) uit de backlog leest en idempotent toevoegt aan de DB, zónder bestaande data te raken. Voor M8 nu, en voor M9..M∞ later.

Bron-keuze: backlog ipv plan-bestand

Twee bronnen denkbaar:

  • .Plans/<datum>-<slug>.md — freeform plan-tekst, niet gestructureerd, niet gecommit
  • docs/backlog/index.md — al strict gestructureerd, gecommit, single source of truth voor alle bestaande seed-pipelines

Voorstel: het script leest de backlog. Workflow blijft natuurlijk:

  1. Plan schrijven naar .Plans/<naam>.md (lokaal, draft)
  2. Milestone-sectie + stories formaliseren in docs/backlog/index.md (PR)
  3. Na merge: npm run db:insert-milestone -- M8 [--product SCRUM4ME]

Eén canonical bron, geen ambiguïteit, en de bestaande parser doet 90% van het werk al.

Wijzigingen

1. prisma/seed-data/parse-backlog.ts — tolerant maken

Huidige parser kent alleen M0..M6 in MILESTONE_PRIORITY/_GOAL/_SPRINT_STATUS + asserts ≥8 milestones / ≥60 stories. M7 en M8 worden nu stilletjes overgeslagen.

Concrete edits:

  • Voeg M7 en M8 toe aan de drie maps (M7: priority 4, sprint COMPLETED, goal "MCP-server voor Claude Code"; M8: priority 4, sprint COMPLETED, goal "Realtime updates voor Solo Paneel")
  • Voor onbekende sleutels: fallback naar priority: 4, sprint_status: 'COMPLETED', goal: <header-title>. Dat maakt M9..M∞ vanzelf bruikbaar zonder code-wijziging
  • Verwijder de strikte filter KNOWN_KEYS.includes(...) of verleg naar een "alle-M[\d.]+ headers" check
  • Voeg optionele loadBacklog(repoRoot, { strict?: boolean }) toe. strict: true (default) behoudt de bestaande "≥8 milestones, ≥60 stories" asserts (zodat de seed niet stilletjes anders gedraagt). Insert-milestone roept met strict: false

2. scripts/insert-milestone.ts (nieuw, ~90 regels)

Usage: tsx scripts/insert-milestone.ts <milestone-key> [--product <code>] [--dry-run]
Default product code: SCRUM4ME

Logica:

  1. Parse args; valideer dat milestone-key matcht ^M[\d.]+$
  2. loadBacklog(repoRoot, { strict: false })
  3. Zoek milestone op key; faal helder met "milestone not found in docs/backlog/index.md" als ie er niet in staat
  4. Lookup product via code (default SCRUM4ME); faal als niet gevonden
  5. Upsert PBI:
    • where: { product_id_code: { product_id, code: milestone.key } }
    • sort_order = (max(sort_order) van bestaande PBIs in product) + 1 als nieuw, anders ongemoeid
  6. Voor elke story:
    • Upsert Story op (product_id, code = story.ref)
    • status = 'DONE' of 'OPEN' zoals gemarkeerd in markdown
    • sort_order, priority en pbi_id correct ingesteld
  7. Voor elke task: bulk insert alleen als de story op dit moment 0 tasks heeft (idempotent — herhaling dupliceert niets)
  8. Print samenvatting: M8: PBI created, 6 stories upserted (1 created, 5 unchanged), 6 tasks created
  9. --dry-run: alle DB-calls overslaan, alleen wat het zou doen printen

Edge cases:

  • Story-code conflict tussen producten: schema heeft @@unique([product_id, code]) op Story dus dit is per-product safe
  • Tasks zonder code veld in DB (klopt — code wordt afgeleid van story.code + index in get_claude_context)
  • Demo-product: script accepteert --product DEMO o.i.d. — niet hardcoded SCRUM4ME

3. package.json script

"db:insert-milestone": "tsx scripts/insert-milestone.ts"

4. Verificatie na implementatie

  • Dry-run eerst: npm run db:insert-milestone -- M8 --dry-run
  • Daarna echt: npm run db:insert-milestone -- M8
  • In Prisma Studio of via SQL: zie M8 PBI, 6 stories, 6 tasks onder SCRUM4ME-product
  • Tweede run: npm run db:insert-milestone -- M8 → "0 created, 6 unchanged" — geen duplicaten
  • Niet-bestaande key: npm run db:insert-milestone -- M99 → "milestone M99 not found"
  • Bestaande seed-flow blijft werken: prisma db seed met strict: true faalt nog steeds bij format-drift in de backlog

Branch- en PR-strategie

scripts/insert-milestone.ts is orthogonaal aan ST-801. Twee keuzes:

  • A. Eigen mini-branch + PRtooling/insert-milestone-script, ~95 regels code, makkelijk reviewbaar, gemerged voordat M8 verder gaat. Daarna gebruiken om M8 in DB te zetten en met de implementatie door.
  • B. Aan ST-801 plakken — voegt scope toe aan een PR die al code ↔ infra-overschrijdend is (migratie + tools).

Voorgestelde keuze: A. De tool is breder bruikbaar dan M8 alleen.

Volgorde

  1. Switch naar main (ST-801 blijft op zijn eigen branch staan)
  2. Branch tooling/insert-milestone-script
  3. Edit parse-backlog.ts (M7/M8 maps + tolerant + strict-mode option)
  4. Schrijf scripts/insert-milestone.ts
  5. Voeg db:insert-milestone toe aan package.json
  6. Lokaal testen met M8 (dry-run + echt + tweede run)
  7. Commit, push, PR
  8. Na merge: tool gebruiken om M8 in DB te krijgen, daarna ST-802 oppakken op feat/ST-801-branch

Geschatte size

  • ~10 regels parser-edit
  • ~95 regels nieuw script
  • ~1 regel package.json
  • ~25 regels test/usage doc in script-comment
  • 1 commit, 1 PR