80 — Handleidingen
Taakgerichte gidsen voor het bedienen van de apps in het portfolio. Waar referentie (70-api-referentie/) antwoord geeft op "wat is het contract", beantwoorden handleidingen "hoe krijg ik dit voor elkaar".
Handleidingen zijn eigen inhoud van Documentatie. Ze wonen hier (en niet in één product-repo) omdat de waardevolste workflows meerdere apps raken.
Wanneer wel
- Een gebruikerstaak loopt over meer dan één app en de per-app README is te smal
- Een workflow heeft een canonieke "juiste manier" die niet per gebruiker opnieuw afgeleid hoort te worden
- Een scenario wordt vaker dan twee keer gevraagd
Wanneer niet
- API-contracten — die zijn referentie (
70-api-referentie/) - Single-screen UI-flows die al door in-app hulp of een product-PRD worden gedekt
- Bureauproces "hoe het bedrijf werkt" — dat is Ruimtemeesters Processen
- Eenmalige verkenningen — schrijf een
25-onderzoek/-notitie
Statuswaarden
| Status | Betekenis |
|---|---|
| Concept | Wordt geschreven |
| Actueel | Reflecteert hoe de apps zich nu gedragen |
| Verouderd | Loopt aantoonbaar achter; gemarkeerd voor refresh |
| Gearchiveerd | De workflow bestaat niet meer; bewaard ter historie |
Bestandspatroon
- Single-app:
<app>-<taak>-handleiding.md— bijv.databank-import-raadsstuk-handleiding.md,geoportaal-overlay-publiceren-handleiding.md - Cross-app:
<taak>-handleiding.md— bijv.bopa-toetsing-end-to-end-handleiding.md
Sjabloon
# <Taak> — Handleiding
**Laatst bijgewerkt:** YYYY-MM-DD
**Status:** Concept | Actueel | Verouderd | Gearchiveerd
**Betrokken apps:** <app>, <app>
## Wat deze handleiding dekt
(Eén alinea. Welk resultaat behaalt de lezer door dit te volgen.)
## Voor je begint
(Voorwaarden: toegang, credentials, eerdere data-staat, dingen die al moeten bestaan.)
## Stappen
1. **<Stapnaam>** — wat te doen, in welke app, wat te verwachten
2. **<Stapnaam>** —
3. **<Stapnaam>** —
## Veelvoorkomende varianten
(Vertakkingen: "als je in plaats daarvan X doet, …". Hou dit kort — bij vijf varianten zitten er waarschijnlijk twee handleidingen in één.)
## Foutzoeken
| Symptoom | Waarschijnlijke oorzaak | Oplossing |
|---|---|---|
| | | |
## Gerelateerd
- Referentie: [[referentie-pagina]]
- Atlas: [[atlas-pagina]]