docs: design-document v1.8, dev-docs restructure, VitePress user docs scaffold, backlog update

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-10 11:16:43 +02:00
parent 03ca1a50a7
commit 83437378c8
53 changed files with 3924 additions and 114 deletions

View File

@@ -0,0 +1,26 @@
---
title: [Concept naam]
description: [Eén zin uitleg van het concept]
tags: []
---
# {{ $frontmatter.title }}
{{ $frontmatter.description }}
## In het kort
[2-3 zinnen die het concept uitleggen alsof je het aan iemand zonder technische kennis vertelt.]
## Hoe past dit in Crewli?
[Beschrijf de context: waar kom je dit concept tegen, en waarom is het belangrijk?]
## Voorbeeld
[Concreet voorbeeld uit de praktijk van festivalbeheer.]
## Gerelateerde concepten
- [Concept A](/guide/concepts#...)
- [Concept B](/guide/concepts#...)

View File

@@ -0,0 +1,41 @@
---
title: [Feature naam]
description: [Eén zin die beschrijft wat de feature doet]
tags: []
---
# {{ $frontmatter.title }}
{{ $frontmatter.description }}
## Wat is dit?
[Korte uitleg in 2-3 zinnen: wat doet deze feature en waarom is het nuttig?]
## Hoe werkt het?
### Stap 1 — [Actie]
[Beschrijving met eventueel een screenshot placeholder: `![Beschrijving](./images/placeholder.png)`]
### Stap 2 — [Actie]
[Beschrijving]
## Rollen en toegang
| Rol | Toegang |
|-----|---------|
| Organisatie Admin | Volledige toegang |
| Event Manager | [Specificeer] |
| Vrijwilliger | [Specificeer] |
## Veelgestelde vragen
### [Vraag 1]?
[Antwoord]
## Gerelateerde pagina's
- [Gerelateerde feature](/organizer/...)

View File

@@ -0,0 +1,65 @@
# Crewli Documentatie Stijlgids
## Doelgroep
Crewli-documentatie is geschreven voor mensen die evenementen en festivals organiseren.
Zij zijn praktisch ingesteld, hebben weinig tijd, en willen snel weten hoe iets werkt.
Ga NIET uit van technische kennis.
## Toon en stijl
- Schrijf in het **Nederlands** (informeel "je/jij", niet "u")
- Wees **direct en bondig** — geen inleidingen van drie alinea's
- Gebruik **actieve zinnen**: "Klik op Opslaan" in plaats van "Er kan op Opslaan geklikt worden"
- Vermijd jargon — als een term nodig is, leg hem uit of link naar de woordenlijst
## Vaste terminologie
Gebruik ALTIJD deze termen — geen synoniemen:
| Term in Crewli | NIET gebruiken |
|----------------|----------------|
| Evenement | Event (in user-facing docs) |
| Sectie | Afdeling, area, zone (tenzij Access Zone) |
| Dienst | Shift (in user-facing docs) |
| Tijdslot | Tijdblok, slot |
| Vrijwilliger | Volunteer (in user-facing docs) |
| Persoon | Deelnemer, gast (tenzij specifieke crowd type) |
| Crowd type | Bezoekerstype, categorie |
| Crowd lijst | Gastenlijst (alleen als het crowd type 'guest' is) |
| Accreditatie | Badge, pas |
| Access zone | Toegangszone |
| Advancing | Rider, tech spec |
| Briefing | Instructie, info |
| Festival serie | Festival reeks, parent event |
## Paginastructuur
1. **Titel** — wat het IS (niet wat het doet)
2. **Eerste alinea** — wat en waarom, max 3 zinnen
3. **Hoe werkt het** — stappen met screenshots
4. **Rollen en toegang** — wie mag wat
5. **FAQ** — alleen als er echte vragen zijn, geen opvulling
6. **Gerelateerde pagina's** — links naar verwante features
## Screenshots
- Gebruik placeholders tijdens ontwikkeling: `![Alt tekst](./images/placeholder.png)`
- Naamgeving: `feature-naam-stap-nummer.png` (bijv. `event-aanmaken-stap-2.png`)
- Bewaar in een `images/` map binnen de betreffende sectie
- Geen persoonlijke data zichtbaar in screenshots
## Frontmatter
Elke pagina MOET deze frontmatter hebben:
```yaml
---
title: Paginatitel
description: Eén zin beschrijving
tags: [relevante, tags, voor, zoeken]
---
```
Tags gebruiken de Crewli-terminologie (zie tabel hierboven).
Gebruik minimaal 2 tags, maximaal 6.