Documentatie die je klanten én Joomla helpt!
Documentatie die je klanten én Joomla helpt!
Schrijf jij handleidingen, tutorials of instructies voor contentbeheerders of klanten? Dan is dit artikel iets voor jou! Ontdek hoe Joomla jou daarbij kan helpen – en hoe jij Joomla kunt helpen.
Zaterdag 23 augustus 2025: Vandaag ga ik mijn ochtend besteden aan het schrijven van mijn allereerste Joomla-documentatie. Ik doe dit als onderdeel van Pizza, Bugs and Fun (PBF), een wereldwijd evenement om bugs op te lossen en Joomla te verbeteren, dat twee keer per jaar plaatsvindt. Iedereen kan meedoen aan PBF-evenementen. Dat is een van de redenen waarom PBF ook het schrijven van documentatie als activiteit omvat. Zelfs als het oplossen van bugs of het testen van pull requests niet jouw ding is, kun je helpen door de documentatie te verbeteren – en zo Joomla ondersteunen.
Waarom documentatie belangrijk is
Documentatie speelt een cruciale rol in het succes van een CMS. Als gebruikers je software te moeilijk vinden om te gebruiken, zullen ze ermee stoppen. Als je ze op een duidelijke, vriendelijke en logische manier door de functionaliteiten leidt, zullen ze zich op hun gemak voelen, zelfverzekerd worden en nieuwsgierig raken. Daarom heeft Joomla Guided Tours en documentatie.
Tutorials voor verschillende doelgroepen
De huidige gebruikersdocumentatie van Joomla heeft tutorials nodig met een systematische structuur: om iets over het ene onderwerp te leren, moet je eerst iets over een ander onderwerp weten. Bijvoorbeeld: om te leren hoe je een artikel bewerkt, moet je eerst weten wat een artikel is. En om een artikel zichtbaar te maken op je site, moet je iets weten over menu-items. Deze eenvoudige dingen zijn niet meteen duidelijk voor nieuwe Joomla-gebruikers.
Verschillende delen van de gebruikersdocumentatie richten zich op verschillende doelgroepen, zoals sitebouwers, technische beheerders of contentleveranciers. Contentbeheerders hoeven meestal niet te weten hoe ze een Joomla-site moeten bouwen, hoe ze technische onderhoudstaken moeten uitvoeren of hoe ze back-ups moeten maken. Rollen kunnen overlappen, maar bureaus die websites bouwen, instrueren klanten vaak hoe ze de content van de site moeten beheren, of leren mensen hoe ze de software up-to-date moeten houden.
Contentbeheer-tutorials voor beginners
Sinds de laatste Pizza, Bugs and Fun richt het documentatieteam zich eerst op het schrijven van contentbeheer-tutorials voor beginners. Dat is wat we vandaag gaan doen. Herman Peeren, teamleider van het Documentatieteam, heeft een wensenlijst met onderwerpen opgesteld. Hij heeft ook een Google Meet geopend, zodat we kunnen bespreken wat er gedaan moet worden en hoe. Na een kort gesprek met Herman en Dieter Ziller (lid van het Documentatieteam) kies ik mijn onderwerp: lijsten – over het toevoegen van genummerde en ongeordende lijsten in artikelen.
Vergelijkbaar met het schrijven van instructies voor klanten
Het is niet de eerste keer dat ik documentatie schrijf: in de tien jaar dat ik websites voor klanten bouw, heb ik hen altijd uitgebreide handleidingen gegeven, zodat ze hun content met plezier en zelfvertrouwen konden beheren.
Het schrijven van deze Joomla-tutorials lijkt daar sterk op. Zodra ik begin met schrijven, realiseer ik me hoe belonend het al voelt om de basisfunctionaliteiten uit te leggen. Als je documentatie schrijft, maak je iets dat nuttig is voor iemand anders. Ergens ter wereld zal iemand iets kunnen doen wat ze nog nooit eerder deden, alleen maar omdat jij dit hebt opgeschreven – zelfs als het alleen maar gaat om het maken van een lijst in hun artikel.
Ik ontdek ook dat het schrijven van documentatie/tutorials niet alleen gaat over het beschrijven van wat je moet doen en hoe het werkt, maar ook over het nemen van beslissingen. Bijvoorbeeld: beschrijven we meerniveau-lijsten? En zo ja, hoe ver gaan we daarin? Een tutorial hoeft niet compleet te zijn; dat zou meer een referentietype documentatie zijn. Een tutorial laat iets zien, in plaats van er alleen over te schrijven.
Ditzelfde geldt voor mijn tweede artikel, over intro- en fulltext-afbeeldingen: beschrijven we hoe je de afbeeldingsklasse gebruikt (antwoord: nee, niet in een beginners-tutorial)? Moet er een klein probleemoplossend gedeelte in (antwoord: ja, want soms ziet de gebruiker het tabblad Afbeeldingen en links niet)?
Aan het eind van de ochtend ben ik trots om Herman te vertellen dat mijn twee documentatie-artikelen klaar zijn om bekeken te worden!
We kunnen dit voor elkaar laten werken
De beginners-tutorials voor contentbeheer zijn niet alleen handig voor nieuwe gebruikers die hun eigen site beheren; ze kunnen ook nuttig zijn voor webdesignbureaus of sitebeheerders. In plaats van steeds opnieuw tutorials voor je klanten of gebruikers te moeten schrijven, kun je een backend-module maken met links naar de relevante tutorial-artikelen in de Joomla-documentatie. Daarvoor moeten de tutorials wel eerst compleet zijn. En dat is waar jij om de hoek komt kijken.
Als je toch een tutorial moet schrijven, waarom schrijf je hem dan niet voor Joomla en voeg je hem vervolgens toe aan een mooie tutorial-module in je backend?
Ga nu naar https://docs-core.sandbox.joomla.org/contributors en laten we Joomla de best gedocumenteerde CMS ter wereld maken!
Hartelijk dank aan Herman Peeren voor het toevoegen van waardevolle informatie aan dit artikel.
Dit artikel werd oorspronkelijk gepubliceerd in het Joomla Community Magazine.
Lees alle artikelen in het magazine via deze link
Joomla! bestaat al 20 jaar als Open Source project. Dat is een lange tijd in technologiejaren! 19 jaar geleden kon je niet eens een iPhone bezitten, of X gebruiken en waarschijnlijk had je geen Facebook-account maar een Hyves-account 😊.
Er is veel gebeurd, maar Joomla! is al die tijd een duurzame keuze gebleken als CMS voor miljoenen websites wereldwijd, ondersteund door een betrokken community.