updating docs

2026-05-30 03:47:52 +02:00 · 2026-05-30 03:47:52 +02:00 · 37f6a55798
commit 37f6a55798
parent caa2f7d395
2 changed files with 93 additions and 9 deletions
--- a/documentation/ai-context/99-current-task-blueprint.md
+++ b/documentation/ai-context/99-current-task-blueprint.md
@ -0,0 +1,108 @@
+# 99 — Current Task
+
+> **Purpose:** Fill out this template before giving a task to an LLM. Concatenate with 00-project-overview.md and relevant domain files (01–06). After the task is complete, ask the LLM to review this checklist and suggest doc updates.
+> **Last updated:** 2026-05-15
+> **Depends on:** 00-project-overview.md, prompts/meta.md
+
+---
+
+## Task Description
+
+**What I'm building / fixing / refactoring:**
+
+[Describe the task in 1–2 sentences. Be specific.]
+
+Example: "Implement guest play flow so users can try a 3-round quiz without creating an account."
+
+---
+
+## Context
+
+**Which parts of the codebase does this touch?**
+
+- [ ] Frontend (`apps/web/`)
+- [ ] Backend API (`apps/api/`)
+- [ ] Database schema (`packages/db/`)
+- [ ] Shared schemas (`packages/shared/`)
+- [ ] WebSocket protocol (`apps/api/src/ws/`)
+- [ ] Data pipeline (`data-pipeline/`)
+- [ ] Infrastructure / deployment (`docker-compose.yml`, Caddyfile, etc.)
+- [ ] Documentation
+
+**Relevant files I already know about:**
+
+[List files you've identified. The LLM may ask for additional ones.]
+
+Example:
+
+- `apps/api/src/controllers/gameController.ts` — needs guest variant
+- `apps/api/src/middleware/authMiddleware.ts` — needs optional auth path
+- `packages/shared/src/schemas/game.ts` — needs GuestGameRequestSchema
+
+---
+
+## Constraints & Requirements
+
+**Must have:**
+
+- [ ]
+- [ ]
+
+**Nice to have:**
+
+- [ ]
+- [ ]
+
+**Must NOT break:**
+
+- [ ] Existing auth flow (logged-in users still work normally)
+- [ ] WebSocket protocol (if applicable)
+- [ ] Database schema (additive changes only unless migration planned)
+- [ ] Zod schemas in `packages/shared` (no silent drift)
+
+**Known blockers or open questions:**
+
+- [ ]
+
+---
+
+## Definition of Done
+
+- [ ] Code implemented and tested
+- [ ] No TypeScript errors (`pnpm typecheck` passes)
+- [ ] Tests pass (`pnpm test`)
+- [ ] Manual verification in dev environment
+- [ ] Commit message follows convention (see prompts/meta.md)
+- [ ] Feature branch merged to main
+
+---
+
+## Post-Work Checklist
+
+After the task is complete, ask the LLM:
+
+> "Review the post-work checklist in prompts/meta.md. Which documentation files need updates based on what we just changed?"
+
+The LLM should check:
+
+| File                               | Check if...                                                             |
+| ---------------------------------- | ----------------------------------------------------------------------- |
+| `documentation/STATUS.md`          | Task changes what's working or what's blocked                           |
+| `documentation/BACKLOG.md`         | Task completes a backlog item or creates a new one                      |
+| `documentation/DECISIONS.md`       | Task involved choosing between alternatives with long-term consequences |
+| `documentation/ARCHITECTURE.md`    | Task changes monorepo structure, data flow, or layer boundaries         |
+| `documentation/ai-context/*.md`    | Task changes schemas, endpoints, protocol, or pipeline stages           |
+| `packages/shared/src/schemas/*.ts` | Task changes request/response shapes or WS message types                |
+| `README.md`                        | Task changes quickstart steps, stack, or current status                 |
+
+**Expected output format:**
+
+```
+- FILE: [filename] — REASON: [what changed and why the doc needs updating]
+```
+
+---
+
+## Notes
+
+[Any additional context, links, or scratch notes for this specific task.]