66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
# 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: ``
|
|
- 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.
|