bouwplan templates

This commit is contained in:
colinislit
2025-11-11 09:28:46 +01:00
parent 530b8f1bdb
commit dbde412465
13 changed files with 1374 additions and 300 deletions

369
docs/templates/bouwplan_template.md vendored Normal file
View File

@@ -0,0 +1,369 @@
# 🚀 Mission Control — Bouwplan Template
💡 **Tip:** Dit document kun je samenstellen met hulp van AI-tools zoals **ChatGPT, Claude, Cursor** of **Gemini**.
Gebruik ze als **sparringpartner** om de bouw van je software te plannen, te documenteren en te verbeteren — zelfs als je geen ontwikkelaar bent.
Afhankelijk van de **complexiteit van je software** bepaal je zelf hoe gedetailleerd je elk onderdeel uitwerkt. Voor kleine prototypes volstaat een beknopt overzicht; voor grotere projecten kun je per fase en subfase inzoomen.
---
**Projectnaam:** _[vul in]_
**Versie:** _v1.0_
**Datum:** _[dd-mm-jjjj]_
**Auteur:** _[naam]_
---
## 1. Doel en context
🎯 **Doel:** Leg uit wat je gaat bouwen en waarom.
📘 **Toelichting:** Beschrijf kort de aanleiding voor het project en hoe het past binnen je organisatie of productstrategie. Verwijs hier naar het PRD of FO voor achtergrond.
**Voorbeeld:**
> Het doel is een werkend MVP te bouwen van de AI-assistent voor zorgdossiers. We tonen de meerwaarde van AI binnen de intake → profiel → plan workflow.
---
## 2. Uitgangspunten
### 2.1 Technische Stack
🎯 **Doel:** Benoem de technologieën en frameworks die worden gebruikt.
📘 **Toelichting:** Denk aan frontend, backend, database, hosting en externe services.
**Voorbeeld:**
- **Frontend:** SvelteKit + Tailwind CSS + Lucide Icons
- **Backend:** Firebase Functions / Next.js API Routes
- **Database:** Firestore / PostgreSQL
- **AI/ML:** Vertex AI (Gemini) / OpenAI API
- **Hosting:** Vercel / Firebase Hosting
- **Auth:** Firebase Auth / Supabase Auth
### 2.2 Projectkaders
🎯 **Doel:** Benoem de vaste kaders waarbinnen het project wordt ontwikkeld.
📘 **Toelichting:** Denk aan beperkingen (tijd, budget, resources) en aannames.
**Voorbeeld:**
- **Tijd:** 3 weken bouwtijd voor MVP
- **Budget:** €X voor externe services (API calls, hosting)
- **Team:** 1 developer + 1 consultant/sparringpartner
- **Data:** Geen productiegegevens (alle data fictief voor demo)
- **Doel:** Demo op AI-inspiratiesessie
### 2.3 Programmeer Uitgangspunten
🎯 **Doel:** Vastleggen van code-kwaliteit principes en development best practices.
📘 **Toelichting:** Deze principes gelden voor alle code die in dit project wordt geschreven.
**Code Quality Principles:**
- **DRY (Don't Repeat Yourself)**
- Herbruikbare componenten en functies
- Centrale configuratie voor herhaalde waarden
- Utility functions voor gemeenschappelijke logica
- **KISS (Keep It Simple, Stupid)**
- Eenvoudige oplossingen boven complexe architectuur
- Duidelijke naamgeving (spreekt voor zich)
- Vermijd premature optimization
- **SOC (Separation of Concerns)**
- UI-componenten gescheiden van business logic
- API-calls in dedicated service layers
- Database queries in repository/model layers
- Styling gescheiden van functionaliteit
- **YAGNI (You Aren't Gonna Need It)**
- Bouw alleen wat nu nodig is
- Geen features "voor later"
- Iteratief uitbreiden op basis van feedback
**Development Practices:**
- **Code Organization**
- Consistent folder structure (`/components`, `/lib`, `/routes`, `/api`)
- Één component/functie per file waar logisch
- Index files voor clean imports
- **Error Handling**
- Try-catch blocks op alle async operaties
- User-friendly foutmeldingen in UI
- Logging van errors naar console/monitoring
- **Security**
- Nooit API keys in frontend code
- Input validation op alle user input
- Firestore/database rules voor data access control
- CORS configuratie voor API endpoints
- **Performance**
- Lazy loading waar mogelijk
- Debounce op search/input handlers
- Optimized images en assets
- Minimal bundle size (tree-shaking)
- **Testing**
- Unit tests voor kritieke business logic
- Integration tests voor API endpoints
- Smoke tests voor belangrijkste flows
- Manual testing checklist voor demo
- **Documentation**
- README met setup instructies
- Inline comments voor complexe logica
- JSDoc/TypeScript types voor public APIs
- Architecture Decision Records (ADR) voor belangrijke keuzes
**Voorbeeld implementatie:**
```typescript
// ❌ NIET - Violation of DRY
if (user.role === 'admin') { /* ... */ }
if (user.role === 'admin') { /* ... */ }
// ✅ WEL - DRY principle
const isAdmin = (user) => user.role === 'admin';
if (isAdmin(user)) { /* ... */ }
// ❌ NIET - Violation of SOC
<button onClick={() => {
fetch('/api/data').then(r => r.json()).then(data => {
setState(data);
});
}}>
Load
</button>
// ✅ WEL - SOC principle
// In /lib/api.ts
export const loadData = async () => {
const response = await fetch('/api/data');
return response.json();
};
// In component
<button onClick={handleLoad}>Load</button>
```
---
## 3. Epics & Stories Overzicht
🎯 **Doel:** De bouw opdelen in logische epics (fases) met stories (subfases).
📘 **Toelichting:** Elke epic bevat het doel, afhankelijkheden en status. Stories zijn de uitvoerbare taken binnen een epic.
**Epic Structuur:**
| Epic ID | Titel | Doel | Status | Stories | Opmerkingen |
|---------|-------|------|--------|---------|-------------|
| E0 | Setup & Configuratie | Repo, omgeving, dependencies | ✅ Gereed | 4 | Config getest |
| E1 | Data & Database | Datamodel en demo-data | 🔄 In Progress | 3 | Rules nog aanvullen |
| E2 | UI & Layout | Interface, navigatie, componenten | ⏳ To Do | 3 | Wireframes gereed |
| E3 | AI-integratie | AI endpoints en prompt engineering | ⏳ To Do | 3 | Test met Gemini model |
| E4 | Testing & Deploy | QA, demo prep en deployment | ⏳ To Do | 3 | |
---
## 4. Epics & Stories (Uitwerking)
🎯 **Doel:** Verdeel complexe epics in beheersbare stories voor meer overzicht.
📘 **Toelichting:** Je bepaalt zelf het detailniveau. Kleine projecten kunnen volstaan met 2-3 stories per epic; grotere implementaties kunnen tot 10 stories bevatten.
### Epic 0 — Setup & Configuratie
**Epic Doel:** Werkende development omgeving met alle benodigde tools en dependencies.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E0.S1 | Repository aanmaken | GitHub repo + lokale clone, `.gitignore` config | ✅ | — | 1 |
| E0.S2 | Project initialisatie | `npm create` draait, dev server start | ✅ | E0.S1 | 2 |
| E0.S3 | Dependencies installeren | Tailwind, Firebase, TypeScript geïnstalleerd | 🔄 | E0.S2 | 2 |
| E0.S4 | Environment variables | `.env.local` + Vercel vars geconfigureerd | ⏳ | E0.S3 | 1 |
**Technical Notes:**
- Gebruik `pnpm` voor snellere installs
- `.env.example` committen voor team onboarding
---
### Epic 1 — Data & Database
**Epic Doel:** Werkend datamodel met seed data voor development en demo.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E1.S1 | Datamodel ontwerpen | ERD/schema gedocumenteerd, collections defined | 🔄 | E0.S4 | 3 |
| E1.S2 | Security Rules implementeren | Firestore rules geschreven en getest | ⏳ | E1.S1 | 3 |
| E1.S3 | Demo-data seeden | 3+ testcliënten met complete intake data | ⏳ | E1.S1 | 2 |
**Technical Notes:**
- Collections: `clients`, `intakes`, `plans`, `ai_events`
- Demo user heeft `all access` voor development
- Seed script: `npm run seed`
---
### Epic 2 — UI & Layout
**Epic Doel:** Gebruiksvriendelijke interface volgens UX/FO specificatie.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E2.S1 | Layout skelet bouwen | Topbalk + linker navigatie responsive | ⏳ | E1.S3 | 5 |
| E2.S2 | Component library setup | Herbruikbare buttons, cards, forms | ⏳ | E2.S1 | 3 |
| E2.S3 | Routing & navigatie | `/clients/[id]` structuur werkt, breadcrumbs | ⏳ | E2.S1 | 3 |
**Technical Notes:**
- shadcn/ui componenten of custom Tailwind components
- Keyboard shortcuts: Ctrl+S (save), Cmd+K (search)
- Mobile-first approach
---
### Epic 3 — AI-integratie
**Epic Doel:** Werkende AI-features voor samenvatten, extraheren en plannen genereren.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E3.S1 | Vertex AI configuratie | GCP project + SA key, test call succesvol | ⏳ | E0.S4 | 3 |
| E3.S2 | API endpoints bouwen | `/api/summarize`, `/extract`, `/plan` werken | ⏳ | E3.S1, E1.S3 | 8 |
| E3.S3 | Logging & monitoring | AI calls loggen naar `ai_events` collection | ⏳ | E3.S2 | 2 |
**Technical Notes:**
- Model: `gemini-1.5-pro` of `gemini-2.0-flash`
- Prompt templates in `/lib/prompts/`
- Error handling voor rate limits en API failures
- Response caching voor repeated calls
---
### Epic 4 — Testing & Deployment
**Epic Doel:** Stabiele, geteste applicatie live op productie omgeving.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E4.S1 | Smoke tests uitvoeren | Alle happy flows werken zonder crashes | ⏳ | E3.S3 | 3 |
| E4.S2 | Demo dry-run | Volledige demo in max 10 minuten | ⏳ | E4.S1 | 2 |
| E4.S3 | Productie deployment | Live op Vercel, environment vars gezet | ⏳ | E4.S2 | 2 |
**Technical Notes:**
- Test scenarios gedocumenteerd in `/docs/test-plan.md`
- Vercel deployment: EU region (Amsterdam)
- Rollback plan als deployment faalt
---
## 5. Kwaliteit & Testplan
🎯 **Doel:** vastleggen hoe de kwaliteit van het project wordt geborgd.
📘 **Toelichting:** Licht toe welke tests je uitvoert en hoe je weet dat de build stabiel is.
### Test Types
| Test Type | Scope | Tools | Verantwoordelijke |
|-----------|-------|-------|-------------------|
| Unit Tests | Business logic, utilities | Vitest / Jest | Developer |
| Integration Tests | API endpoints, database | Playwright / Supertest | Developer |
| Smoke Tests | Kritieke user flows | Manual checklist | QA / Developer |
| Performance Tests | Load times, API response | Lighthouse, Network tab | Developer |
| Security Tests | Auth, data access, XSS | Manual + OWASP checklist | Developer |
### Test Coverage Targets
- **Unit tests:** 80%+ coverage op `/lib` folder
- **Integration tests:** Alle API endpoints
- **Smoke tests:** 3 happy flows + 2 error scenarios
### Manual Test Checklist (voor demo)
- [ ] User kan inloggen
- [ ] Nieuwe cliënt aanmaken werkt
- [ ] Intake formulier opslaan werkt
- [ ] AI samenvatting genereert binnen 5 sec
- [ ] Behandelplan wordt gegenereerd
- [ ] Navigatie werkt zonder errors
- [ ] Mobile view is responsive
- [ ] Error states tonen user-friendly messages
---
## 6. Demo & Presentatieplan
🎯 **Doel:** beschrijven hoe de demo wordt gepresenteerd of getest.
📘 **Toelichting:** Vermeld wat je laat zien, wie betrokken is en welk scenario wordt gevolgd.
### Demo Scenario
**Duur:** 10 minuten
**Doelgroep:** Zorgorganisatie stakeholders + management
**Locatie:** Live op Vercel (backup: localhost)
**Flow:**
1. **Intro** (1 min): Context en doel van de AI-assistent
2. **Nieuwe cliënt** (2 min): Aanmaken + intake invullen
3. **AI in actie** (4 min):
- Samenvatting genereren
- Belangrijkste punten extractie
- Behandelplan voorstel
4. **Interactie** (2 min): Aanpassingen maken, opslaan
5. **Afsluiting** (1 min): Vragen + next steps
**Backup Plan:**
- Lokale versie klaar bij internet issues
- Pre-seeded data als AI API niet reageert
- Screenshots als complete fallback
---
## 7. Risico's & Mitigatie
🎯 **Doel:** risico's vroeg signaleren en voorzien van oplossingen.
📘 **Toelichting:** Gebruik dit als dynamische checklist.
| Risico | Kans | Impact | Mitigatie | Owner |
|--------|------|--------|-----------|-------|
| AI-output inconsistent | Hoog | Hoog | Snapshot tests, prompt versioning, fallback responses | Developer |
| API rate limits tijdens demo | Middel | Hoog | Caching, pre-warmed responses, backup data | Developer |
| Firebase regels te open | Middel | Hoog | Strikte rules voor productie, security audit | Developer |
| Tijdsdruk deadline | Hoog | Middel | Prioriteer MVP features, cut scope indien nodig | PM |
| Browser compatibility issues | Laag | Middel | Test op Chrome, Safari, Firefox | QA |
| Environment vars niet gezet | Middel | Hoog | `.env.example` + deployment checklist | DevOps |
---
## 8. Evaluatie & Lessons Learned
🎯 **Doel:** reflecteren op het proces en verbeteringen vastleggen.
📘 **Toelichting:** noteer inzichten na elke sprint of oplevering.
**Te documenteren na project:**
- Wat ging goed? Wat niet?
- Welke AI-tools waren het meest effectief?
- Welke prompts werkten het beste?
- Waar liepen we vertraging op?
- Wat doen we volgende keer anders?
- Herbruikbare componenten voor volgende projecten
---
## 9. Referenties
🎯 **Doel:** koppelen aan de overige Mission Control-documenten.
**Mission Control Documents:**
- **PRD** — Product Requirements Document
- **FO** — Functioneel Ontwerp
- **TO** — Technisch Ontwerp
- **UX/UI** — Design specificatie
- **API Access** — Authenticatie en endpoints documentatie
**External Resources:**
- Repository: `https://github.com/[org]/[project]`
- Deployment: `https://[project].vercel.app`
- Design: Figma link
- Documentation: `/docs` folder in repo
---
## 10. Glossary & Abbreviations
| Term | Betekenis |
|------|-----------|
| Epic | Grote feature of fase in development (bevat meerdere stories) |
| Story | Kleine, uitvoerbare taak binnen een epic |
| Story Points | Schatting van complexiteit (Fibonacci: 1, 2, 3, 5, 8, 13) |
| MVP | Minimum Viable Product |
| DRY | Don't Repeat Yourself |
| KISS | Keep It Simple, Stupid |
| SOC | Separation of Concerns |
| YAGNI | You Aren't Gonna Need It |
| SA | Service Account (GCP) |
| ADR | Architecture Decision Record |
---
**Versiehistorie:**
| Versie | Datum | Auteur | Wijziging |
|--------|-------|--------|-----------|
| v1.0 | [datum] | [naam] | Initiële versie |

140
docs/templates/fo_template.md vendored Normal file
View File

@@ -0,0 +1,140 @@
# 🧩 Functioneel Ontwerp (FO) Template
**Projectnaam:** _[vul in]_
**Versie:** _v1.0_
**Datum:** _[dd-mm-jjjj]_
**Auteur:** _[naam]_
---
## 1. Doel en relatie met het PRD
🎯 **Doel van dit document:**
Het Functioneel Ontwerp (FO) beschrijft **hoe** het product uit het PRD functioneel zal werken — dus wat de gebruiker ziet, doet en ervaart. Waar het PRD uitlegt *wat en waarom*, laat het FO zien *hoe dit in de praktijk werkt*.
📘 **Toelichting aan de lezer:**
Gebruik dit document om een gedeeld beeld te creëren tussen ontwerp, ontwikkeling en stakeholders. Het FO hoort compact te blijven: één niveau dieper dan het PRD, niet technisch maar functioneel-concreet.
---
## 2. Overzicht van de belangrijkste onderdelen
🎯 **Doel:** kort overzicht van de modules, schermen of onderdelen binnen de app of tool.
📘 **Toelichting:** som de kernschermen of modules op (zoals Dashboard, Cliëntenlijst, Editor, AI-rail). Dit helpt de lezer snel te begrijpen waar het FO over gaat.
**Voorbeeld:**
1. Dashboard / Overzicht
2. Cliëntdossier
3. Intakeverslag
4. Probleemprofiel
5. Behandelplan
6. *(Optioneel)* Rapportage / Agenda
---
## 3. Userstories (sjabloon + voorbeelden)
🎯 **Doel:** beschrijven wat gebruikers moeten kunnen doen, vanuit hun perspectief.
📘 **Toelichting:** gebruik dit vaste sjabloon:
**User Story Template:**
> Als [rol/gebruiker] wil ik [doel of actie] zodat [reden/waarde].
**Voorbeeld:**
> Als behandelaar wil ik snel een intakeverslag kunnen samenvatten zodat ik sneller tot een behandelplan kom.
**Aanvullende kolommen (optioneel):**
| ID | Rol | Doel / Actie | Verwachte waarde | Prioriteit |
|----|------|---------------|------------------|-------------|
| US-01 | Behandelaar | Nieuwe cliënt aanmaken | Kan direct starten met intake | Hoog |
| US-02 | Behandelaar | Intake samenvatten met AI | Tijdbesparing, inzicht | Hoog |
| US-03 | PO | Inzage demo-flow | Begrijpt AI toegevoegde waarde | Middel |
---
## 4. Functionele werking per onderdeel
🎯 **Doel:** per hoofdonderdeel beschrijven wat de gebruiker kan doen en wat het systeem doet.
📘 **Toelichting:** dit is de kern van het FO. Gebruik korte, actiematige beschrijvingen. Focus op gedrag, states en interacties.
**Voorbeeldstructuur:**
### 4.1 Dashboard / Overzicht
* Toont kaarten met samenvattingen van cliëntinformatie (intake, profiel, plan).
* Knoppen: *Nieuw verslag*, *Ga naar behandelplan*.
* Leeg-staat: melding “Nog geen dossiers”.
### 4.2 Intakeverslag
* Rich text editor met knoppen voor *Opslaan*, *AI-samenvatten*, *Leesbaarheid*.
* AI-resultaat verschijnt in rechterzijpaneel (AI-rail).
* Gebruiker kan *Preview → Invoegen* of *Annuleren*.
### 4.3 Probleemprofiel
* Formulier met dropdown (categorie) en slider (severity).
* AI-suggestie met bronverwijzing uit intake.
* Bevestigen activeert *Behandelplan* tab.
### 4.4 Behandelplan
* Vier secties: Doelen, Interventies, Frequentie/Duur, Meetmomenten.
* Gebruiker kan elke sectie aanpassen of regenereren via micro-AI-acties.
* Knoppen: *Opslaan* (concept), *Publiceer v1*.
---
## 5. UI-overzicht (visuele structuur)
🎯 **Doel:** eenvoudig inzicht geven in de globale schermopbouw.
📘 **Toelichting:** gebruik dit als communicatiemiddel met ontwerpers of developers. Het is geen pixel-perfect ontwerp, maar een functionele schets.
**Voorbeeld (ASCII-layout):**
```
┌───────────────────────────────────────────────┐
│ Topbalk: cliëntnaam, acties, zoeken │
├───────────────┬───────────────────────────────┤
│ Linkernav │ Middenpaneel (inhoud) │
│ (Overzicht, │ Detail, formulieren, editor) │
│ Intake, Prof.)│ │
├───────────────┴───────────────────────────────┤
│ Footer: status / toasts │
└───────────────────────────────────────────────┘
```
**Tip:** Combineer dit later met wireframes of UX-schetsen uit Figma of Gamma.app.
---
## 6. Interacties met AI (functionele beschrijving)
🎯 **Doel:** uitleggen waar AI in de flow voorkomt en wat de gebruiker ziet of verwacht.
📘 **Toelichting:** beschrijf per AI-actie kort de trigger, verwerking en output.
**Voorbeeld:**
| Locatie | AI-actie | Trigger | Output |
|----------|-----------|----------|---------|
| Intake-editor | Samenvatten | Klik op knop *AI Samenvatten* | Bullets in rechterzijpaneel |
| Intake-editor | Leesbaarheid (B1) | Klik op knop *AI Leesbaarheid* | Herschreven tekstversie |
| Profiel | Extract problemen | Klik op *AI Extract* | Categorie + severity + bronzinnen |
| Plan | Genereer behandelplan | Klik op *AI Plan genereren* | Secties met bewerkbare doelen |
---
## 7. Gebruikersrollen en rechten (optioneel)
🎯 **Doel:** beschrijven welke rollen toegang hebben tot welke onderdelen.
📘 **Toelichting:** alleen opnemen als het project meerdere gebruikersgroepen kent.
**Voorbeeld:**
| Rol | Toegang tot | Beperkingen |
|------|--------------|-------------|
| Behandelaar | Alle cliëntdossiers | Alleen eigen dossiers bewerken |
| Manager | Rapportages | Geen bewerkingen |
| Demo-user | Alles (fictieve data) | Alleen lezen |
---
## 8. Bijlagen & Referenties
🎯 **Doel:** linken naar de overige documenten binnen Mission Control.
**Verwijzingen:**
- PRD (Product Requirements Document)
- TO (Technisch Ontwerp)
- UX/UI-specificatie
- Mission Control / Build Plan
- API Access Document

369
docs/templates/prd_template.md vendored Normal file
View File

@@ -0,0 +1,369 @@
# 🚀 Mission Control — Bouwplan Template
💡 **Tip:** Dit document kun je samenstellen met hulp van AI-tools zoals **ChatGPT, Claude, Cursor** of **Gemini**.
Gebruik ze als **sparringpartner** om de bouw van je software te plannen, te documenteren en te verbeteren — zelfs als je geen ontwikkelaar bent.
Afhankelijk van de **complexiteit van je software** bepaal je zelf hoe gedetailleerd je elk onderdeel uitwerkt. Voor kleine prototypes volstaat een beknopt overzicht; voor grotere projecten kun je per fase en subfase inzoomen.
---
**Projectnaam:** _[vul in]_
**Versie:** _v1.0_
**Datum:** _[dd-mm-jjjj]_
**Auteur:** _[naam]_
---
## 1. Doel en context
🎯 **Doel:** Leg uit wat je gaat bouwen en waarom.
📘 **Toelichting:** Beschrijf kort de aanleiding voor het project en hoe het past binnen je organisatie of productstrategie. Verwijs hier naar het PRD of FO voor achtergrond.
**Voorbeeld:**
> Het doel is een werkend MVP te bouwen van de AI-assistent voor zorgdossiers. We tonen de meerwaarde van AI binnen de intake → profiel → plan workflow.
---
## 2. Uitgangspunten
### 2.1 Technische Stack
🎯 **Doel:** Benoem de technologieën en frameworks die worden gebruikt.
📘 **Toelichting:** Denk aan frontend, backend, database, hosting en externe services.
**Voorbeeld:**
- **Frontend:** SvelteKit + Tailwind CSS + Lucide Icons
- **Backend:** Firebase Functions / Next.js API Routes
- **Database:** Firestore / PostgreSQL
- **AI/ML:** Vertex AI (Gemini) / OpenAI API
- **Hosting:** Vercel / Firebase Hosting
- **Auth:** Firebase Auth / Supabase Auth
### 2.2 Projectkaders
🎯 **Doel:** Benoem de vaste kaders waarbinnen het project wordt ontwikkeld.
📘 **Toelichting:** Denk aan beperkingen (tijd, budget, resources) en aannames.
**Voorbeeld:**
- **Tijd:** 3 weken bouwtijd voor MVP
- **Budget:** €X voor externe services (API calls, hosting)
- **Team:** 1 developer + 1 consultant/sparringpartner
- **Data:** Geen productiegegevens (alle data fictief voor demo)
- **Doel:** Demo op AI-inspiratiesessie
### 2.3 Programmeer Uitgangspunten
🎯 **Doel:** Vastleggen van code-kwaliteit principes en development best practices.
📘 **Toelichting:** Deze principes gelden voor alle code die in dit project wordt geschreven.
**Code Quality Principles:**
- **DRY (Don't Repeat Yourself)**
- Herbruikbare componenten en functies
- Centrale configuratie voor herhaalde waarden
- Utility functions voor gemeenschappelijke logica
- **KISS (Keep It Simple, Stupid)**
- Eenvoudige oplossingen boven complexe architectuur
- Duidelijke naamgeving (spreekt voor zich)
- Vermijd premature optimization
- **SOC (Separation of Concerns)**
- UI-componenten gescheiden van business logic
- API-calls in dedicated service layers
- Database queries in repository/model layers
- Styling gescheiden van functionaliteit
- **YAGNI (You Aren't Gonna Need It)**
- Bouw alleen wat nu nodig is
- Geen features "voor later"
- Iteratief uitbreiden op basis van feedback
**Development Practices:**
- **Code Organization**
- Consistent folder structure (`/components`, `/lib`, `/routes`, `/api`)
- Één component/functie per file waar logisch
- Index files voor clean imports
- **Error Handling**
- Try-catch blocks op alle async operaties
- User-friendly foutmeldingen in UI
- Logging van errors naar console/monitoring
- **Security**
- Nooit API keys in frontend code
- Input validation op alle user input
- Firestore/database rules voor data access control
- CORS configuratie voor API endpoints
- **Performance**
- Lazy loading waar mogelijk
- Debounce op search/input handlers
- Optimized images en assets
- Minimal bundle size (tree-shaking)
- **Testing**
- Unit tests voor kritieke business logic
- Integration tests voor API endpoints
- Smoke tests voor belangrijkste flows
- Manual testing checklist voor demo
- **Documentation**
- README met setup instructies
- Inline comments voor complexe logica
- JSDoc/TypeScript types voor public APIs
- Architecture Decision Records (ADR) voor belangrijke keuzes
**Voorbeeld implementatie:**
```typescript
// ❌ NIET - Violation of DRY
if (user.role === 'admin') { /* ... */ }
if (user.role === 'admin') { /* ... */ }
// ✅ WEL - DRY principle
const isAdmin = (user) => user.role === 'admin';
if (isAdmin(user)) { /* ... */ }
// ❌ NIET - Violation of SOC
<button onClick={() => {
fetch('/api/data').then(r => r.json()).then(data => {
setState(data);
});
}}>
Load
</button>
// ✅ WEL - SOC principle
// In /lib/api.ts
export const loadData = async () => {
const response = await fetch('/api/data');
return response.json();
};
// In component
<button onClick={handleLoad}>Load</button>
```
---
## 3. Epics & Stories Overzicht
🎯 **Doel:** De bouw opdelen in logische epics (fases) met stories (subfases).
📘 **Toelichting:** Elke epic bevat het doel, afhankelijkheden en status. Stories zijn de uitvoerbare taken binnen een epic.
**Epic Structuur:**
| Epic ID | Titel | Doel | Status | Stories | Opmerkingen |
|---------|-------|------|--------|---------|-------------|
| E0 | Setup & Configuratie | Repo, omgeving, dependencies | ✅ Gereed | 4 | Config getest |
| E1 | Data & Database | Datamodel en demo-data | 🔄 In Progress | 3 | Rules nog aanvullen |
| E2 | UI & Layout | Interface, navigatie, componenten | ⏳ To Do | 3 | Wireframes gereed |
| E3 | AI-integratie | AI endpoints en prompt engineering | ⏳ To Do | 3 | Test met Gemini model |
| E4 | Testing & Deploy | QA, demo prep en deployment | ⏳ To Do | 3 | |
---
## 4. Epics & Stories (Uitwerking)
🎯 **Doel:** Verdeel complexe epics in beheersbare stories voor meer overzicht.
📘 **Toelichting:** Je bepaalt zelf het detailniveau. Kleine projecten kunnen volstaan met 2-3 stories per epic; grotere implementaties kunnen tot 10 stories bevatten.
### Epic 0 — Setup & Configuratie
**Epic Doel:** Werkende development omgeving met alle benodigde tools en dependencies.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E0.S1 | Repository aanmaken | GitHub repo + lokale clone, `.gitignore` config | ✅ | — | 1 |
| E0.S2 | Project initialisatie | `npm create` draait, dev server start | ✅ | E0.S1 | 2 |
| E0.S3 | Dependencies installeren | Tailwind, Firebase, TypeScript geïnstalleerd | 🔄 | E0.S2 | 2 |
| E0.S4 | Environment variables | `.env.local` + Vercel vars geconfigureerd | ⏳ | E0.S3 | 1 |
**Technical Notes:**
- Gebruik `pnpm` voor snellere installs
- `.env.example` committen voor team onboarding
---
### Epic 1 — Data & Database
**Epic Doel:** Werkend datamodel met seed data voor development en demo.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E1.S1 | Datamodel ontwerpen | ERD/schema gedocumenteerd, collections defined | 🔄 | E0.S4 | 3 |
| E1.S2 | Security Rules implementeren | Firestore rules geschreven en getest | ⏳ | E1.S1 | 3 |
| E1.S3 | Demo-data seeden | 3+ testcliënten met complete intake data | ⏳ | E1.S1 | 2 |
**Technical Notes:**
- Collections: `clients`, `intakes`, `plans`, `ai_events`
- Demo user heeft `all access` voor development
- Seed script: `npm run seed`
---
### Epic 2 — UI & Layout
**Epic Doel:** Gebruiksvriendelijke interface volgens UX/FO specificatie.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E2.S1 | Layout skelet bouwen | Topbalk + linker navigatie responsive | ⏳ | E1.S3 | 5 |
| E2.S2 | Component library setup | Herbruikbare buttons, cards, forms | ⏳ | E2.S1 | 3 |
| E2.S3 | Routing & navigatie | `/clients/[id]` structuur werkt, breadcrumbs | ⏳ | E2.S1 | 3 |
**Technical Notes:**
- shadcn/ui componenten of custom Tailwind components
- Keyboard shortcuts: Ctrl+S (save), Cmd+K (search)
- Mobile-first approach
---
### Epic 3 — AI-integratie
**Epic Doel:** Werkende AI-features voor samenvatten, extraheren en plannen genereren.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E3.S1 | Vertex AI configuratie | GCP project + SA key, test call succesvol | ⏳ | E0.S4 | 3 |
| E3.S2 | API endpoints bouwen | `/api/summarize`, `/extract`, `/plan` werken | ⏳ | E3.S1, E1.S3 | 8 |
| E3.S3 | Logging & monitoring | AI calls loggen naar `ai_events` collection | ⏳ | E3.S2 | 2 |
**Technical Notes:**
- Model: `gemini-1.5-pro` of `gemini-2.0-flash`
- Prompt templates in `/lib/prompts/`
- Error handling voor rate limits en API failures
- Response caching voor repeated calls
---
### Epic 4 — Testing & Deployment
**Epic Doel:** Stabiele, geteste applicatie live op productie omgeving.
| Story ID | Beschrijving | Acceptatiecriteria | Status | Afhankelijkheden | Story Points |
|----------|--------------|---------------------|--------|------------------|--------------|
| E4.S1 | Smoke tests uitvoeren | Alle happy flows werken zonder crashes | ⏳ | E3.S3 | 3 |
| E4.S2 | Demo dry-run | Volledige demo in max 10 minuten | ⏳ | E4.S1 | 2 |
| E4.S3 | Productie deployment | Live op Vercel, environment vars gezet | ⏳ | E4.S2 | 2 |
**Technical Notes:**
- Test scenarios gedocumenteerd in `/docs/test-plan.md`
- Vercel deployment: EU region (Amsterdam)
- Rollback plan als deployment faalt
---
## 5. Kwaliteit & Testplan
🎯 **Doel:** vastleggen hoe de kwaliteit van het project wordt geborgd.
📘 **Toelichting:** Licht toe welke tests je uitvoert en hoe je weet dat de build stabiel is.
### Test Types
| Test Type | Scope | Tools | Verantwoordelijke |
|-----------|-------|-------|-------------------|
| Unit Tests | Business logic, utilities | Vitest / Jest | Developer |
| Integration Tests | API endpoints, database | Playwright / Supertest | Developer |
| Smoke Tests | Kritieke user flows | Manual checklist | QA / Developer |
| Performance Tests | Load times, API response | Lighthouse, Network tab | Developer |
| Security Tests | Auth, data access, XSS | Manual + OWASP checklist | Developer |
### Test Coverage Targets
- **Unit tests:** 80%+ coverage op `/lib` folder
- **Integration tests:** Alle API endpoints
- **Smoke tests:** 3 happy flows + 2 error scenarios
### Manual Test Checklist (voor demo)
- [ ] User kan inloggen
- [ ] Nieuwe cliënt aanmaken werkt
- [ ] Intake formulier opslaan werkt
- [ ] AI samenvatting genereert binnen 5 sec
- [ ] Behandelplan wordt gegenereerd
- [ ] Navigatie werkt zonder errors
- [ ] Mobile view is responsive
- [ ] Error states tonen user-friendly messages
---
## 6. Demo & Presentatieplan
🎯 **Doel:** beschrijven hoe de demo wordt gepresenteerd of getest.
📘 **Toelichting:** Vermeld wat je laat zien, wie betrokken is en welk scenario wordt gevolgd.
### Demo Scenario
**Duur:** 10 minuten
**Doelgroep:** Zorgorganisatie stakeholders + management
**Locatie:** Live op Vercel (backup: localhost)
**Flow:**
1. **Intro** (1 min): Context en doel van de AI-assistent
2. **Nieuwe cliënt** (2 min): Aanmaken + intake invullen
3. **AI in actie** (4 min):
- Samenvatting genereren
- Belangrijkste punten extractie
- Behandelplan voorstel
4. **Interactie** (2 min): Aanpassingen maken, opslaan
5. **Afsluiting** (1 min): Vragen + next steps
**Backup Plan:**
- Lokale versie klaar bij internet issues
- Pre-seeded data als AI API niet reageert
- Screenshots als complete fallback
---
## 7. Risico's & Mitigatie
🎯 **Doel:** risico's vroeg signaleren en voorzien van oplossingen.
📘 **Toelichting:** Gebruik dit als dynamische checklist.
| Risico | Kans | Impact | Mitigatie | Owner |
|--------|------|--------|-----------|-------|
| AI-output inconsistent | Hoog | Hoog | Snapshot tests, prompt versioning, fallback responses | Developer |
| API rate limits tijdens demo | Middel | Hoog | Caching, pre-warmed responses, backup data | Developer |
| Firebase regels te open | Middel | Hoog | Strikte rules voor productie, security audit | Developer |
| Tijdsdruk deadline | Hoog | Middel | Prioriteer MVP features, cut scope indien nodig | PM |
| Browser compatibility issues | Laag | Middel | Test op Chrome, Safari, Firefox | QA |
| Environment vars niet gezet | Middel | Hoog | `.env.example` + deployment checklist | DevOps |
---
## 8. Evaluatie & Lessons Learned
🎯 **Doel:** reflecteren op het proces en verbeteringen vastleggen.
📘 **Toelichting:** noteer inzichten na elke sprint of oplevering.
**Te documenteren na project:**
- Wat ging goed? Wat niet?
- Welke AI-tools waren het meest effectief?
- Welke prompts werkten het beste?
- Waar liepen we vertraging op?
- Wat doen we volgende keer anders?
- Herbruikbare componenten voor volgende projecten
---
## 9. Referenties
🎯 **Doel:** koppelen aan de overige Mission Control-documenten.
**Mission Control Documents:**
- **PRD** — Product Requirements Document
- **FO** — Functioneel Ontwerp
- **TO** — Technisch Ontwerp
- **UX/UI** — Design specificatie
- **API Access** — Authenticatie en endpoints documentatie
**External Resources:**
- Repository: `https://github.com/[org]/[project]`
- Deployment: `https://[project].vercel.app`
- Design: Figma link
- Documentation: `/docs` folder in repo
---
## 10. Glossary & Abbreviations
| Term | Betekenis |
|------|-----------|
| Epic | Grote feature of fase in development (bevat meerdere stories) |
| Story | Kleine, uitvoerbare taak binnen een epic |
| Story Points | Schatting van complexiteit (Fibonacci: 1, 2, 3, 5, 8, 13) |
| MVP | Minimum Viable Product |
| DRY | Don't Repeat Yourself |
| KISS | Keep It Simple, Stupid |
| SOC | Separation of Concerns |
| YAGNI | You Aren't Gonna Need It |
| SA | Service Account (GCP) |
| ADR | Architecture Decision Record |
---
**Versiehistorie:**
| Versie | Datum | Auteur | Wijziging |
|--------|-------|--------|-----------|
| v1.0 | [datum] | [naam] | Initiële versie |

268
docs/templates/to_template.md vendored Normal file
View File

@@ -0,0 +1,268 @@
# ⚙️ Technisch Ontwerp (TO) Template
**Projectnaam:** _[vul in]_
**Versie:** _v1.0_
**Datum:** _[dd-mm-jjjj]_
**Auteur:** _[naam]_
---
## 1. Doel en relatie met PRD en FO
🎯 **Doel van dit document:**
Het Technisch Ontwerp (TO) beschrijft **hoe** het systeem technisch wordt gebouwd. Waar het PRD het *wat* beschrijft en het FO het *hoe functioneel*, gaat het TO over architectuur, techstack, data en infrastructuur.
📘 **Toelichting:**
Gebruik dit document om technische keuzes te onderbouwen en developers een duidelijk beeld te geven van de technische implementatie.
---
## 2. Technische Architectuur Overzicht
🎯 **Doel:** Globaal beeld van de systeemarchitectuur.
📘 **Toelichting:** Schets de hoofdcomponenten en hun relaties.
**Voorbeeld (high-level):**
```
┌─────────────┐ ┌──────────────┐ ┌─────────────┐
│ Frontend │────▶│ Backend │────▶│ Database │
│ (Next.js) │ │ (API Routes)│ │ (Supabase) │
└─────────────┘ └──────────────┘ └─────────────┘
│ │
│ ▼
│ ┌──────────────┐
└──────────▶│ AI Services │
│ (OpenAI/etc) │
└──────────────┘
```
---
## 3. Techstack Selectie
🎯 **Doel:** Onderbouwde keuze van technologieën.
📘 **Toelichting:** Beschrijf per component welke technologie je kiest en waarom.
**Voorbeeld:**
| Component | Technologie | Argumentatie | Alternatieven |
|-----------|-------------|--------------|---------------|
| Frontend | Next.js 15 | React framework, SSR, goede DX | SvelteKit, Remix |
| Backend | Next.js API Routes | Co-located met frontend, TypeScript | Express, FastAPI |
| Database | Supabase (PostgreSQL) | Realtime, auth included, gratis tier | Firebase, PlanetScale |
| AI | OpenAI GPT-4 | Betrouwbaar, goede docs, Nederlands | Claude, Gemini |
| Styling | TailwindCSS | Utility-first, snel prototypen | styled-components |
| Hosting | Vercel | Zero-config Next.js, preview deploys | Netlify, Railway |
---
## 4. Datamodel
🎯 **Doel:** Structuur van de data in de database.
📘 **Toelichting:** Beschrijf de belangrijkste tabellen/collections en hun relaties.
**Voorbeeld (PostgreSQL):**
```sql
-- Users
users (
id UUID PRIMARY KEY,
email TEXT UNIQUE,
name TEXT,
role TEXT,
created_at TIMESTAMP
)
-- Clients
clients (
id UUID PRIMARY KEY,
name TEXT,
user_id UUID REFERENCES users(id),
created_at TIMESTAMP
)
-- Intakes
intakes (
id UUID PRIMARY KEY,
client_id UUID REFERENCES clients(id),
content TEXT,
ai_summary TEXT,
created_at TIMESTAMP
)
```
**ERD (optioneel):**
```
users ─1:N─ clients ─1:N─ intakes
```
---
## 5. API Ontwerp
🎯 **Doel:** Overzicht van belangrijkste endpoints.
📘 **Toelichting:** Beschrijf REST/GraphQL endpoints, input/output en authenticatie.
**Voorbeeld (REST):**
| Endpoint | Method | Input | Output | Auth |
|----------|--------|-------|--------|------|
| `/api/clients` | GET | - | `Array<Client>` | Required |
| `/api/clients` | POST | `{ name }` | `Client` | Required |
| `/api/clients/:id` | GET | - | `Client` | Required |
| `/api/ai/summarize` | POST | `{ text }` | `{ summary }` | Required |
| `/api/ai/extract` | POST | `{ text }` | `{ categories, severity }` | Required |
**Authenticatie:**
- Session-based via Supabase Auth
- JWT tokens in HTTP-only cookies
- CSRF protection via SameSite cookies
---
## 6. Security & Compliance
🎯 **Doel:** Beschrijf security maatregelen en compliance vereisten.
📘 **Toelichting:** Vooral relevant voor zorg, finance, overheid.
**Security Checklist:**
- [ ] **Authentication:** Supabase Auth (OAuth, MFA support)
- [ ] **Authorization:** Row Level Security (RLS) policies
- [ ] **Data Encryption:** At rest (PostgreSQL), in transit (HTTPS)
- [ ] **Input Validation:** Zod schemas op alle endpoints
- [ ] **Rate Limiting:** Vercel Edge Functions (100 req/min)
- [ ] **CORS:** Restrictive origins (alleen eigen domein)
- [ ] **Secrets Management:** Environment variables, niet in code
**Compliance (AVG/GDPR):**
- Data minimalisatie: Alleen noodzakelijke velden opslaan
- Consent: Expliciete toestemming voor AI-verwerking
- Right to deletion: `/api/users/:id/delete` endpoint
- Data export: `/api/users/:id/export` endpoint (JSON)
- Logging: Audit trail voor data access (wie, wanneer, wat)
**NEN7510 (voor zorginstellingen):**
- Toegangscontrole per rol (behandelaar, manager, admin)
- Logging van medische dossier toegang
- Encryptie van gevoelige velden (BSN, medische data)
---
## 7. AI/LLM Integratie
🎯 **Doel:** Technische details van AI-gebruik.
📘 **Toelichting:** Beschrijf hoe AI wordt geïntegreerd, welke modellen, prompts, fallbacks.
**AI Stack:**
- **Provider:** OpenAI (gpt-4-turbo)
- **Library:** OpenAI SDK (JavaScript/Python)
- **Prompting:** System prompts + few-shot examples
- **Caching:** Redis voor repeated prompts (kosten besparing)
- **Fallback:** Error handling → default response + user notification
**Voorbeeld Prompt Template:**
```typescript
const SUMMARIZE_PROMPT = `
Je bent een medisch assistent. Vat de volgende intake samen in maximaal 3 bullets.
Format:
- [hoofdprobleem]
- [relevante context]
- [actie suggestie]
Intake:
${intakeText}
`;
```
**Cost Management:**
- Token limits: Max 4000 tokens per request
- Caching: Identical prompts cached 1 hour
- Monitoring: Track costs per endpoint via OpenAI dashboard
---
## 8. Performance & Scalability
🎯 **Doel:** Hoe schaalt het systeem bij groei?
📘 **Toelichting:** Beschrijf performance targets en schaalbaarheid.
**Performance Targets:**
- Page load: < 2 seconden (First Contentful Paint)
- API response: < 500ms (excl. AI calls)
- AI response: < 5 seconden (GPT-4)
**Scalability Strategie:**
- **Frontend:** Vercel Edge Network (CDN, global caching)
- **Backend:** Serverless functions (auto-scaling)
- **Database:** Supabase (vertical scaling, read replicas)
- **AI:** Queue systeem (Bull/BullMQ) voor batch processing
**Caching:**
- Static assets: CDN cache (immutable)
- API responses: Redis (5 min TTL)
- AI results: Database cache (1 uur, per prompt hash)
---
## 9. Deployment & CI/CD
🎯 **Doel:** Hoe wordt het systeem gedeployed en getest?
📘 **Toelichting:** Beschrijf deployment pipeline en omgevingen.
**Omgevingen:**
- **Development:** Lokaal (localhost:3000)
- **Staging:** Vercel preview (PR builds)
- **Production:** Vercel production (main branch)
**CI/CD Pipeline:**
```
Git Push → GitHub Actions → [Lint, Test, Build] → Vercel Deploy
```
**Deployment Checklist:**
- [ ] Environment variables set (Vercel dashboard)
- [ ] Database migrations run (Supabase migrations)
- [ ] Smoke tests passed (Playwright E2E)
- [ ] Monitoring configured (Sentry, LogRocket)
---
## 10. Monitoring & Logging
🎯 **Doel:** Hoe monitoren we het systeem in productie?
📘 **Toelichting:** Beschrijf logging, error tracking, analytics.
**Tools:**
- **Error Tracking:** Sentry (crashes, exceptions)
- **Logging:** Vercel Logs (server-side), Console (client-side)
- **Analytics:** Vercel Analytics (traffic, performance)
- **Uptime:** UptimeRobot (ping endpoints elke 5 min)
**Key Metrics:**
- Uptime: Target 99.5%
- Error rate: < 1% of requests
- AI success rate: > 95% (non-error responses)
- Response time p95: < 1 seconde
---
## 11. Risico's & Technische Mitigatie
🎯 **Doel:** Technische risico's vroegtijdig identificeren.
📘 **Toelichting:** Beschrijf risico's en hoe je ze technisch aanpakt.
**Voorbeeld:**
| Risico | Impact | Waarschijnlijkheid | Mitigatie |
|--------|--------|-------------------|-----------|
| OpenAI API down | Hoog | Laag | Fallback naar Claude, error messages |
| Database overload | Hoog | Middel | Connection pooling, query optimization |
| Security breach | Kritiek | Laag | RLS policies, input validation, audit logs |
| Vendor lock-in (Supabase) | Middel | Laag | Abstract DB layer, export scripts ready |
| Cost overrun (AI) | Middel | Middel | Token limits, caching, usage monitoring |
---
## 12. Bijlagen & Referenties
🎯 **Doel:** Linken naar tech docs en tooling.
**Projectdocumenten:**
- PRD (Product Requirements Document)
- FO (Functioneel Ontwerp)
- Mission Control / Build Plan
**Tech Documentatie:**
- Next.js: https://nextjs.org/docs
- Supabase: https://supabase.com/docs
- OpenAI: https://platform.openai.com/docs
- Vercel: https://vercel.com/docs
**Code Repositories:**
- GitHub: [link]
- Figma designs: [link]