Scrum4Me/docs/plans/archive/2026-04-27-claude-md-workflow-update.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

7.1 KiB

title status audience language last_updated applies_to
CLAUDE.md workflow-update na M7 + ST-509/511/512/513 done
maintainer
contributor
nl 2026-05-03
M7
ST-509
ST-511
ST-512
ST-513

Plan: CLAUDE.md workflow-update na M7 + ST-509/511/512/513

Aanleiding

CLAUDE.md is voor het laatst groot bijgewerkt op 2026-04-25 (docs/decisions/agent-instructions-history.md). Sindsdien is er substantieel werk geland dat de workflow raakt:

  • ST-511 entity codes (Product/PBI/Story) — branch- en commit-conventies hangen er nu aan vast
  • ST-513 API hardening — 400 (malformed JSON) vs 422 (zod-validatie), lowercase status-enums op API-grens, StoryLog.metadata JSONB
  • PR #2 review-saga (8 testbestanden faalden bij contract-flip) — duidelijk leerpunt: testpariteit hoort bij contract-wijziging
  • M7 MCP-server — Claude Code praat nu native met Scrum4Me via mcp__scrum4me__* tools en de prompt implement_next_story. De huidige 7-stap "vraag-de-gebruiker"-loop in CLAUDE.md is daarmee gedateerd
  • lib/code-server.ts vs lib/code.ts — split is nodig om client-bundle vrij te houden van pg. Als gotcha noemenswaard
  • Schema-drift cron (trig_015FFUnxjz9WMuhhWNGBQKFD) — wekelijkse remote agent — agents moeten weten wat ze met zijn rapport doen

Doel: CLAUDE.md weerspiegelt de werkelijke 2026-04-27 workflow zonder dat het een changelog wordt.

Scope — wat we wél en niet aanpassen

Wel (in CLAUDE.md):

  1. Workflow-sectie — MCP-first met expliciete fallback
  2. Conventies — uitbreiden met status-enums, foutcodes, test-pariteit, entity codes in commits
  3. Implementatiepatronen — rij voor lib/task-status.ts en lib/code-server.ts-boundary toevoegen
  4. Nieuwe sectie "MCP-integratie" — wat staat er, hoe te gebruiken, link naar mcp repo
  5. Definition of Done — markeer expliciet als MVP-scope; M7 is post-MVP en heeft eigen acceptatie

Niet:

  • Geen changelog of historiek in CLAUDE.md zelf — dat hoort in docs/decisions/agent-instructions-history.md (separate update)
  • Geen volledige herschrijving — bestaande structuur blijft (Wat is Scrum4Me, Spec-tabel, Stack, Conventies, Commit Strategy, etc.)
  • Geen wijziging in AGENTS.md (Codex) — die heeft geen MCP, mag los blijven
  • Geen wijziging in functional-spec/architecture/styling docs — die zijn al actueel

Concrete edits in CLAUDE.md

1. Sectie "Specificatiedocumenten" — uitbreiden

Voeg toe onder de bestaande tabel:

Document Gebruik voor
https://github.com/madhura68/scrum4me-mcp MCP-server repo: tools, prompts, schema-sync workflow

(docs/api/rest-contract.md staat er al — laten staan.)

2. Sectie "Waar te beginnen" — herschrijven

Vervang de 7-stap manual loop door een dual-track:

Track A — via Claude Code MCP (aanbevolen):

1. Roep `mcp__scrum4me__implement_next_story` aan met product_id
   (of `list_products` als je het id niet weet)
2. De prompt orkestreert: get_claude_context → log_implementation
   → per task in_progress/done → log_test_result → log_commit
3. Bouw de tasks in volgorde van `sort_order`
4. Test: `npm run lint && npm test && npm run build`
5. Commit per laag (zie Commit Strategy)

Track B — manueel (Codex of zonder MCP):

  • Lees task in docs/backlog/index.md
  • Volg verder de bestaande 7-stappen-loop

3. Sectie "Implementatiepatronen" — uitbreiden

Twee rijen toevoegen aan de patronen-tabel:

Patroon Bestand
Status-enum mapping (DB ↔ API) lib/task-status.ts
Client/server module-boundary regel: *-server.ts bevat DB-calls, *.ts is pure helpers — nooit import { ... } from 'lib/foo-server' in een client component

4. Sectie "Conventies" — vier regels toevoegen

Voeg toe aan de bestaande lijst:

  • Entity codes: gebruik product/PBI/story-codes in commit-titles wanneer aanwezig (feat(ST-356.2): ...); branchnaam blijft feat/ST-XXX-slug
  • Status-enums op API: lowercase (todo|in_progress|review|done, open|in_sprint|done); DB houdt UPPER_SNAKE; conversie via lib/task-status.ts-mappers — nooit ad-hoc lowercase elders
  • Foutcodes API: 400 alleen voor malformed JSON-body (parse-fout); 422 voor zod-validatie en well-formed-maar-niet-acceptabel; 403 voor demo-tokens. Documenteren in docs/api/rest-contract.md
  • Tests volgen contract: bij API-contract-wijziging (status, foutcode, response-shape) MOET in dezelfde commit ook __tests__/api/ bijgewerkt worden — een falende test op review betekent niet dat de tests "stuk zijn" maar dat de wijziging onvolledig is

5. Nieuwe sectie "MCP-integratie" — toevoegen vóór "Definition of Done"

Korte sectie (~15 regels):

## MCP-integratie

Scrum4Me heeft een eigen MCP-server (repo: `madhura68/scrum4me-mcp`)
die deze API exposed als native tools voor Claude Code.

### Tools beschikbaar in Claude Code
- `mcp__scrum4me__health` — service + DB ping
- `mcp__scrum4me__list_products` — producten waar je toegang tot hebt
- `mcp__scrum4me__get_claude_context` — bundled product/sprint/story/todos
- `mcp__scrum4me__update_task_status`, `_update_task_plan`
- `mcp__scrum4me__log_implementation`, `_log_test_result`, `_log_commit`
- `mcp__scrum4me__create_todo`

### Prompt
- `implement_next_story` (arg: `product_id`) — end-to-end workflow

### Schema-drift bewaking
Wekelijks (maandag 08:00 Amsterdam) draait een remote agent
(`trig_015FFUnxjz9WMuhhWNGBQKFD`) die `vendor/scrum4me` syncet en
`prisma:generate + typecheck` uitvoert in mcp. Als die agent
een drift-rapport opent, hoort dat **vóór** een Scrum4Me-PR met
schema-wijziging gemerged kan worden — zodat de MCP-server niet
stilletjes breekt op runtime.

6. Sectie "Definition of Done" — kop verduidelijken

Wijzig ## Definition of Done## Definition of Done (MVP) en voeg eronder een korte zin toe: "M7 (MCP-server) is post-MVP en heeft eigen acceptatie in docs/backlog/index.md."

Bijwerken van auditdoc

Voeg een sectie aan docs/decisions/agent-instructions-history.md toe (datum: 2026-04-27) met:

  • Aanleiding: ST-509/511/512/513 + M7 + PR #2 review-saga
  • Gecontroleerde wijzigingen: zelfde tabel-stijl als 2026-04-25
  • Nieuwe regels: status-enums op API-grens, error-code split 400/422, test-pariteit bij contract-wijziging, client/server module-boundary
  • Verwijzing naar mcp repo en schema-drift cron

Volgorde van uitvoering

  1. Edits in CLAUDE.md — alle 6 secties hierboven, in volgorde
  2. Edits in docs/decisions/agent-instructions-history.md — nieuwe sectie 2026-04-27
  3. npm run lint — sanity check
  4. Commit als één logische changedocs(workflow): align CLAUDE.md with M7 and post-PR-#2 contract
  5. PR openen — review-bare scope, deploys triggeren maar zijn docs-only

Wat het NIET oplost

  • AGENTS.md (Codex) blijft achter; los aan te pakken indien gewenst
  • Eventuele drift in docs/specs/functional.md rond status-enums — niet onderzocht; te volgen bij volgende audit
  • Geen check of de losse pattern-files in docs/patterns/ nog kloppen — ook volgende audit

Geschatte size

  • ~80 regels toegevoegd/gewijzigd in CLAUDE.md
  • ~30 regels nieuw in docs/decisions/agent-instructions-history.md
  • 1 commit, 1 PR