Scrum4Me/docs/specs/dialogs/task.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
Raw Permalink Blame History

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

TaskDialog Profiel

Volgt docs/patterns/dialog.md (de generieke spec voor élke entity-dialog in Scrum4Me). Dit document beschrijft alleen de Task-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
title string (required) beide trim, 1-120 chars
description string | null beide optional, max 2.000 chars, markdown
implementation_plan string | null beide optional, max 10.000 chars, markdown
priority int (1-4, P1 = hoogste) beide int 1-4, default 3
status TaskStatus enum alleen edit (default TO_DO op create, niet getoond) enum
created_at Date alleen edit read-only metadata in header

TaskStatus enum: TO_DO | IN_PROGRESS | REVIEW | DONE.

Veld-specifiek gedrag

  • Auto-grow textareas (description, implementation_plan) via react-textarea-autosize. Max 6 regels (description) / 12 regels (implementation_plan), daarna overflow-y-auto.
  • Karakter-counter vanaf 75% van de limiet, klein, rechtsonder, text-muted-foreground. Bv. 1547 / 2000.
  • Markdown-hint onder elk textarea: Markdown ondersteund (lijstjes, **vet**, \code`)`.
  • Priority als segmented buttons via <PrioritySelect> / <PrioritySegmented>. Default P3 (Medium).
  • Status met gekleurde dot:
    • TO_DO — grijs
    • IN_PROGRESSstatus-in-progress (blauw)
    • REVIEW — paars
    • DONEstatus-done (groen)
  • created_at als header-metadata in edit-mode, naast de titel: Aangemaakt: 23 apr 2026. Klein, muted-foreground, géén form-veld.

URL- of state-pattern

  • Gekozen: URL-based (searchParams)
  • Reden: TaskDialog wordt geopend vanuit twee context-pagina's (sprint-detail en product-backlog) en moet deep-linkable zijn voor share/refresh-scenario's. Suspense + skeleton voor edit-mode loading is gewenst.
  • Routes:
    /sprint/<sprintId>?newTask=1                      → create
    /sprint/<sprintId>?editTask=<taskId>              → edit
    /products/<productId>/backlog?newTask=1           → create
    /products/<productId>/backlog?editTask=<taskId>   → edit
    
  • Sluiten: router.push(<base-route>) zonder query-params.
  • Server-side fetch in edit-mode: server component fetcht de taak vóór render mét productAccessFilter(userId). Bestaat de taak niet of valt 'm buiten scope → toast + redirect naar de context-route.
  • Optioneel: nuqs als de query-state-handling te omslachtig wordt — pas introduceren als losse refactor-task, niet inline.

Status-veld

Verberg status in create-mode (default = TO_DO is genoeg). Toon alleen in edit-mode als <Select> met gekleurde dot per optie.


Server actions

Actie Locatie Context-arg Revalidatie
saveTask app/actions/tasks.ts { sprintId?: string; productId?: string } revalidatePath('/sprint/<sprintId>') óf revalidatePath('/products/<productId>/backlog') afhankelijk van context
deleteTask app/actions/tasks.ts idem idem

Beide acties volgen de drielaagse demo-policy + auth-scoping uit docs/patterns/dialog.md § 67.


Speciale gedragingen

Triggers (bestaande UI vervangen)

Deze TaskDialog is de enige create/edit-flow voor taken in beide contexten (sprint én backlog). Bestaande inline-edit-paden in components/sprint/task-list.tsx en het backlog-equivalent worden vervangen, niet ernaast geplaatst.

  • Create-trigger: filled button + Nieuwe taak in tasklist-header → zet ?newTask=1 op huidige route
  • Edit-trigger: klik op de hele rij in de tasklist (geen apart edit-icoon) → zet ?editTask=<id> op huidige route
  • Loading edit-mode: Suspense met minimale skeleton (3 grijze balken), 200ms-delay zodat snelle fetches geen flicker tonen

Markdown-rendering elders

description en implementation_plan worden buiten de dialog (taakdetail, hover-card) gerenderd via de gedeelde <Markdown>-wrapper (react-markdown + remark-gfm). Niet in de dialog zelf.


Implementatie-volgorde (suggestie)

Hergebruik dit als checklist bij het bouwen of refactoren van TaskDialog:

  1. Dependencies in package.json (zie docs/patterns/dialog.md § 2)
  2. zod-schema in lib/schemas/task.ts — gedeeld door form en action
  3. productAccessFilter-helper checken in lib/auth/
  4. saveTask / deleteTask in app/actions/tasks.ts met auth-scoping + demo-check (laag 2)
  5. proxy.ts-guard voor demo-write-routes (laag 1) — alleen als nog niet aanwezig
  6. Eventueel ontbrekende MD3-tokens in app/styles/theme.css aanvullen
  7. <DemoTooltip> rond submit/delete-knoppen (laag 3)
  8. TaskDialog — create-mode eerst (minder edge cases)
  9. Edit-mode toevoegen (status, delete, created_at-metadata)
  10. URL-state via native searchParams op beide context-pagina's
  11. Bestaande task-row trigger refactoren (klikbaar maken naar dialog)
  12. Suspense + skeleton voor edit-mode + scope-check op fetch
  13. Dirty-close-guard
  14. Keyboard shortcuts (Cmd+Enter)

Bewust NIET in v1

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

  • Sub-tasks / parent-child relaties tussen taken
  • Tags / labels / categorieën op taken
  • Due dates / reminders per taak
  • Time tracking (uren-registratie) — wel relevant voor inspannings-monitor, eigen feature
  • Sharing / collaboration per taak
  • Templates voor terugkerende taken

Referenties

  • docs/patterns/dialog.md — generieke spec (bron-of-truth voor alles wat hier niet beschreven is)
  • docs/architecture.md — datamodel Task
  • docs/design/styling.md — MD3-tokens, status- en priority-kleuren
  • lib/task-status.ts — enum-mapper DB ↔ API