Scrum4Me/docs/specs/dialogs/pbi.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

6.1 KiB

title status audience language last_updated
PbiDialog Profiel active
ai-agent
contributor
nl 2026-05-03

PbiDialog Profiel

Volgt docs/patterns/dialog.md (de generieke spec voor élke entity-dialog in Scrum4Me). Dit document beschrijft alleen de PBI-specifieke afwijkingen en keuzes — alle gedeelde regels (layout, motion, demo-policy, foutcodes, validatie, theming, dialog-gedrag) staan in de generieke spec en worden hier niet herhaald.

Belangrijk: als een regel in dit profiel botst met de generieke spec, wint de generieke spec. Documenteer hier de afwijking + reden, of pas de generieke spec aan.


Velden

Veld Type Mode Validatie
code string | null beide optional, max 30 chars, mono-font, placeholder auto op create (server kent dan zelf een code toe)
title string (required) beide trim, 1-200 chars
priority int (1-4, P1 = hoogste) beide int 1-4, default 2 (kan via defaultPriority-prop bij create)
status PbiStatusApi enum beide enum, default 'ready'
description string | null beide optional, max 2000 chars, plain textarea (geen markdown rendering binnen de dialog)

PbiStatusApi enum (lowercase, mapped via lib/task-status.ts): zie <PbiStatusSelect> voor de waarden.

Veld-specifiek gedrag

  • Code + Titel in één rij (grid-cols-[6rem_1fr])
  • Prioriteit + Status in één rij (grid-cols-2)
  • Prioriteit via <PrioritySelect> (gedeelde primitive, géén segmented buttons in deze dialog)
  • Status via <PbiStatusSelect> (PBI-specifieke wrapper rond gedeelde select)
  • Description is <Textarea rows={3} resize-none> — géén auto-grow, géén markdown-hint, géén char-counter (afwijking van generieke spec; rationale: PBI-descriptions zijn doorgaans kort en richtinggevend)

URL- of state-pattern

  • Gekozen: state-based (state: PbiDialogState | null prop, gerendeerd binnen PbiList)
  • Reden: PBI-dialog leeft altijd binnen PbiList op de product-backlog-pagina; deep-linking is niet vereist en zou een tweede edit-flow toevoegen.
  • State-shape:
    type PbiDialogState =
      | { mode: 'create'; productId: string; defaultPriority?: number }
      | { mode: 'edit'; pbi: PbiDialogPbi; productId: string }
    
  • Sluiten: onClose() callback uit de parent — setState(null) in PbiList.

Status-veld

  • Default bij create: 'ready' (PBI-default state)
  • Geen verberging in create-mode — anders dan TaskDialog wordt status hier wél getoond bij create, omdat een PBI zonder expliciete status onhandig is voor backlog-grooming

Server actions

Actie Locatie Form-binding Revalidatie
createPbiAction actions/pbis.ts via useActionState + <form action> (FormData) server-side revalidatePath op product-backlog
updatePbiAction actions/pbis.ts idem idem
deletePbiAction (ontbreekt) n.v.t. n.v.t.

Beide acties moeten de drielaagse demo-policy volgen (zie § Bekende gaps).


Speciale gedragingen

Form-state via useActionState

PbiDialog gebruikt het useActionState + useFormStatus-patroon (Server Actions / native React), niet react-hook-form. Dit is een toegestaan alternatief volgens de generieke spec § 2. Field-errors worden gemapt via een lokale fieldError(field)-helper die result.error als Record<string, string[]> interpreteert wanneer 'm geen string is.

key-prop op <form>

Het <form>-element heeft key={isEdit ? pbi!.id : 'create'} — dit reset native form-state (defaultValues) wanneer de dialog tussen create en edit wisselt of wanneer een ander record bewerkt wordt.

Hidden inputs voor server-binding

priority en status worden via <input type="hidden"> doorgegeven aan de Server Action (de UI-controls zijn JS-state, niet directe form-fields).


Triggers

  • Create-trigger: + PBI-knop in PanelNavBar van PbiListsetPbiDialogState({ mode: 'create', ... })
  • Edit-trigger: edit-icoon op een PBI-rij in PbiListsetPbiDialogState({ mode: 'edit', pbi, ... })

Bekende gaps t.o.v. generieke spec

Deze items wijken af van docs/patterns/dialog.md en horen in een vervolg-PR rechtgezet (niet onderdeel van de huidige docs-introductie).

  • Geen <DemoTooltip> rond submit-knop — laag 3 van de drielaagse demo-policy ontbreekt voor PBI-create/update. Dat betekent dat een demo-user de knop kan klikken; de server action blokkeert nog steeds (laag 2), maar de UX is suboptimaal.
  • Geen delete-knop / deletePbiAction — alleen create + update. Of dat bewust is (PBI's worden nooit verwijderd, alleen status veranderd) of een gat, moet expliciet worden besloten en in dit profiel vastgelegd.
  • Geen dirty-close-guard — Esc / backdrop / Cancel sluiten direct, ook met onopgeslagen wijzigingen. Generieke spec § 8.1 vereist een AlertDialog bij isDirty.
  • Geen Cmd/Ctrl+Enter shortcut — alleen klik op submit-knop.
  • Geen char-counter / markdown-hint op description — bewust weggelaten omdat PBI-descriptions kort zijn, maar verdient expliciete bevestiging.
  • ⚠️ Layout wijkt af van de generieke responsive-tabel: sm:max-w-md i.p.v. de max-w-[50vw] / 90vw / full-screen-progressie uit § 4.

Bewust NIET in v1

Specifiek voor PbiDialog (boven op de algemene out-of-scope-lijst in docs/patterns/dialog.md § 13):

  • Inline aanmaken van child-stories binnen de PBI-dialog (gebeurt via StoryDialog vanuit StoryPanel)
  • Bulk-status-update over meerdere PBI's
  • PBI-templates / kopiëren

Referenties

  • components/backlog/pbi-dialog.tsx — implementatie
  • actions/pbis.ts — server actions
  • components/shared/priority-select.tsx — gedeelde priority-control
  • components/shared/pbi-status-select.tsx — PBI-status-select
  • lib/task-status.tsPbiStatusApi-mapper
  • docs/patterns/dialog.md — generieke spec (bron-of-truth)
  • docs/architecture.md — datamodel Pbi
  • docs/design/styling.md — MD3-tokens, status- en priority-kleuren