Gebruikershandleiding
https://github.com/kriskuiper/cmd-digital-playground/wiki
Last updated
https://github.com/kriskuiper/cmd-digital-playground/wiki
Last updated
Om collaborators zo goed mogelijk te faciliteren hebben we een gebruikershandleiding bij de website geschreven. Deze gebruikershandleiding dient met name als een soort guide om nieuwe collaborators op weg te helpen binnen het CMS en onze codebase.
De user test valideerde onze aanname dat er behoefte is aan extra documentatie bij het project omdat de testpersoon totaal geen idee had hoe of wat zij moest doen.
De documentatie is grotendeels onderverdeeld in het volgende:
Over het project Hierin staat wat algemene informatie over de website, hoe het is opgebouwd en hoe het tot stand is gekomen.
How to's Hier kunnen de studenten / docenten / collaborators vinden hoe ze verschillende dingen moeten doen zoals het aanmaken van een pagina of component in het CMS of het werken met Nunjucks, de te gebruiken templating language.
Guidelines Hierin staan wat coding guidelines en principes die iedereen op z'n gemak door kan lezen. Veel dingen worden advised en zijn niet in steen gegraveerd.
API's Allerlei informatie over hoe te werken met (de Storyblok) API's.
FAQ Veelgestelde vragen kunnen hier toegevoegd worden.
Voor de werking van het CMS hebben we de documentatie geschreven per feature. Zo hebben we bijvoorbeeld behandeld hoe je een component moet aanmaken, hoe je een pagina moet aanmaken en hoe je content moet toevoegen aan Storyblok. Met name de 'how to'-pagina's staan ook vol met screenshots etc. om de boel nog duidelijker te maken.
In de toekomst willen we de documentatie hiervoor nog verder uitbreiden en verdelen in kleinere stukken omdat we tijdens de gesprekken met Danny en Mattijs merkten dat de documentatie soms als een heel groot boekwerk oogt en dat verhoogt de drempel voor nieuwe collaborators om te willen werken aan dit project.
Ondanks dat we zo dicht mogelijk bij vanilla HTML, JavaScript en CSS zijn gebleven snappen we dat het voor nieuwe collaborators best lastig kan zijn om te werken aan een onbekende codebase. Daarom hebben we gekozen om ook daarvoor documentatie te schrijven.
Zo hebben we bijvoorbeeld een stuk geschreven over hoe je met de Storyblok API werkt en hoe je data kan ophalen. Ook hebben we in 'About the project' al uitgelegd wat headless is en hoe de website aan z'n content komt etc. zodat het voor nieuwe mensen minder magisch is hoe dit allemaal in elkaar zit.
