Structuur

De wiki maakt gebruik van de concepten shelves (planken), books (boeken) en pages (pagina's). Pagina's kunnen dan weer gegroupeerd worden onder een chapter (hhofdstuk). Net zoals bij gewone boeken zou je kunnen zeggen. In deze wiki moet de content op een pagina. Pagina's moeten in een boek en boeken moeten op een plank. Het is niet mogelijk om losse pagina's of boeken te maken.

Het is belangrijk dat er een duidelijk overzicht is van de planken en de boeken op een plank. Binnen een boek is het vrij makkelijk navigeren van pagina naar pagina. Het is dus erg onhandig als relevante informatie niet in hetzelfde boek staat.

Informatie over hoe om te gaan met planken, boeken en pagina's is te vinden op documentatie van de software: Bookstack

Shelves

Om iedereen op weg te helpen hebben we de planken alvast gedefinieerd. Het is in principe niet de bedoeling dat deze indeling wordt veranderd. Ben je het er niet mee eens of heb je vragen/opmerkingen, dan kan je terecht in het #wiki channel op de nuts Slack . De volgende paragrafen geven uitleg over de verschillende planken.

De Nuts wiki

De Nuts wiki plank bevat informatie over deze wiki. Denk aan handleidingen, uitleg over de structuur en tips over het gebruik van bepaalde termen.

Over Nuts

Op de plank Over Nuts is informatie te vinden over de organisatie structuur en governance. Een belangrijk onderdeel hiervan is de eenheid van taal: wat bedoel je met Nuts? De community, de software, de stichting of het netwerk? Tenslotte bevat de plank informatie over de financiering en eventuele sponsering.

Generieke functies

De plank Generieke functies bevat alle informatie over hoe Nuts zich relateert tot de generieke functies of hoe Nuts hier invulling aangeeft. Onder de generieke functies vallen onder andere identificatie, authenticatie, autorisatie en lokalisatie.

Books

Een boek bevat een opzichzelfstaand onderwerp met informatie verspreid over meerdere hoofdstukken/pagina's. Als je aanvullingen hebt voor de wiki, kijk dan ook altijd eerst of het in een bestaand boek kan. Binnen een boek is het makkelijk navigeren tussen pagina's en hoofdstukken. Het navigeren over boeken is minder overzichtelijk.

Pages

Pagina's bevatten de echte informatie. Een pagina op de wiki is niet te vergelijken met een pagina van een papieren boek. Bij een digitale pagina is het natuurlijk mogelijk om naar beneden te scrollen. Toch is het niet de bedoeling om pagina's mega lang te maken. Een kantje of 3 is de max. Wat goed is om te onthouden, is dat andere pagina's zullen verwijzen naar een pagina. Het is frusterend voor een gebruiker om lang te moeten zoeken op een pagina naar de gewenste informatie.