Documentatiesysteem opzetten in GitHub
Documentatie en community-kennis staan verspreid over losse documenten, kanalen en video's. Nieuwe deelnemers of teamleden moeten zelf uitzoeken waar wat staat, en niemand weet zeker of iets nog actueel is.
De aanpak, stap voor stap
- Stap 1
Structuur en conventies bepalen
Eén logische mappenstructuur en schrijfconventies, passend bij hoe het team en de community werken (bijvoorbeeld markdown-based, versiebeheerd via GitHub).
- Stap 2
Bestaande documentatie migreren
Losse documenten, wiki-pagina's en kennis uit kanalen worden samengebracht en herschreven naar de nieuwe structuur.
- Stap 3
Bijdrage-flow inrichten
Een lichte flow (pull requests, templates, review) zodat het team of de community zelf kan bijdragen zonder dat documentatie weer verspreid raakt.
Tools & technieken
- GitHub (repository, pull requests, GitHub Pages)
- Markdown
- AI-ondersteunde flow voor het herschrijven en structureren van bestaande content
- EU-gehoste tooling waar mogelijk
Resultaat
Eén vindbare, actuele plek voor documentatie in plaats van losse kanalen, met een structuur die het team of de community zelf kan onderhouden.
Video-verslaglegging en website-onderhoud voor een technische community
Voor een technische community wordt de video-nabewerking van community-meetings verzorgd, de website beheerd via GitHub en teksten uitgewerkt over technische toepassingen.
Bekijk de volledige case →Veelgestelde vragen
Moet onze documentatie al in GitHub staan om dit te kunnen doen?
Nee. De meeste trajecten starten juist vanuit losse documenten, een wiki of kanalen. De migratie naar GitHub is onderdeel van het traject.
Werkt dit ook voor een community, niet alleen een intern team?
Ja, bij de Nuts-community is precies dit gedaan: een documentatiesysteem dat zowel het kernteam als externe bijdragers kunnen gebruiken.
Gerelateerde oplossingen
Bespreek jullie documentatie
Kom eens sparren.
20 minuten videogesprek. Geen verplichtingen. Je krijgt direct waardevolle inzichten of een concreet voorstel.