Deze wiki is onze centrale bron voor kennis, runbooks, projectdocumentatie en templates.
Doel: informatie snel vindbaar maken, eenduidig vastleggen en herbruikbaar houden.
De wiki is opgebouwd in logische hoofdsecties, bijvoorbeeld:
ai-config
runbooks
digikwal
womance
templates
best-practice
techdiary
Gebruik de structuur als volgt:
- Zet informatie in de meest logische hoofdsectie.
- Maak subpagina's alleen als er meerdere gerelateerde onderwerpen zijn.
- Houd paden kort, voorspelbaar en stabiel.
- Zoek eerst of een pagina al bestaat.
- Werk bestaande pagina’s bij in plaats van duplicaten te maken.
- Gebruik templates voor terugkerende documenttypes (bijv. meeting notes, runbooks, checklists).
- Schrijf praktisch en actiegericht: wat is het doel, wat zijn de stappen, wat is de uitkomst?
- Kies de juiste sectie (bijv.
runbooks/linux of digikwal/bedrijfsvoering).
- Kies een duidelijke titel die het onderwerp direct benoemt.
- Gebruik deze basisopbouw:
Doel
Context
Stappen
Validatie / Verwachte uitkomst
Rollback / Herstel (indien relevant)
Bronnen / Links (indien relevant)
¶ Standaarden
- Gebruik
kebab-case in paden.
- Gebruik alleen kleine letters, cijfers en
-.
- Vermijd speciale tekens in paden (
&, %, / in bestandsnamen, emoji in padnamen).
- Vermijd vage namen zoals
untitled, notes, test.
- Gebruik betekenisvolle namen zoals
wireguard-vpn-with-keepalived.
- Titel mag leesbaar zijn met hoofdletters en leestekens.
- Titel beschrijft duidelijk onderwerp en context.
- Gebruik dezelfde schrijfwijze in vergelijkbare pagina’s.
- Maximaal 3-4 niveaus diep tenzij echt nodig.
- Gebruik nesting alleen voor functionele groepering, niet voor losse voorkeur.
- Plaats algemene info bovenin, detailpagina’s eronder.
- Begin met een korte samenvatting van 2-4 regels.
- Gebruik korte secties en duidelijke tussenkoppen.
- Voeg concrete commando’s, paden en voorbeelden toe waar relevant.
- Leg keuzes kort uit: waarom doen we dit zo?
- Maak geen pagina’s met suffixen zoals
(1) of copy.
- Bij overlap: merge inhoud en behoud 1 canonieke pagina.
- Verwijs vanuit gerelateerde pagina’s met links in plaats van kopieën.
- Staat de pagina op de juiste plek?
- Is de titel duidelijk en uniek?
- Volgt het pad de naamconventie?
- Zijn stappen reproduceerbaar?
- Is er geen duplicaat van bestaande content?
Bij twijfel: kies eenvoud, duidelijkheid en herbruikbaarheid.