Hoe kan je bijdragen aan de Joomla documentatie?
Ook jij kunt helpen om de Joomla gebruikersdocumentatie te verbeteren!
We willen de gebruikersdocumentatie verbeteren. Op dit moment ligt de focus op de inhoud:
-
Om de gebruikersdocumentatie compleet te maken.
-
Om nieuwe Joomla-gebruikers beter te begeleiden.
De huidige situatie
Een paar jaar geleden heeft Cliff Ford de gebruikersdocumentatie herschikt van de Wiki naar JDocManual. Begin dit jaar hebben we de inhoud van die handleiding gekopieerd naar onze “sandbox-site”: docs-core.sandbox.joomla.org. We zijn nu bezig de alfabetische structuur te herschikken naar een meer logische volgorde, waarbij je stapsgewijs steeds meer over Joomla leert — met een focus op mensen die nieuw zijn met Joomla. Tegelijkertijd brengen we in kaart wat er nog ontbreekt.
Jij kunt op drie manieren helpen:
-
Iedereen kan helpen door nieuwe inhoud toe te voegen, vooral beginnerstutorials. We hebben een lijst waarmee je aan de slag kunt. Dit mag ook af en toe zijn, bijvoorbeeld in een verloren uurtje.
-
We zoeken een paar mensen die structureel tijd willen vrijmaken om documentatie te verwerken, bijdragen te beoordelen en eventueel training te volgen in technisch schrijven en het als team afstemmen van content.
-
Enkele mensen zijn nodig om te helpen bij implementatie en onderhoud van het systeem.
Nieuwe inhoud toevoegen
Gebruikersdocumentatie moet niet alleen door programmeurs worden geschreven. We hebben juist Joomla-gebruikers nodig om het begrijpelijk te maken voor andere, minder technische gebruikers. En hier komt het mooie: iedereen kan helpen! Ben je nieuw met Joomla? Dan is jouw perspectief juist waardevol — je kunt het best beoordelen of de documentatie begrijpelijk is.
We maken het bijdragen zo laagdrempelig mogelijk, door het eerste schrijfwerk te scheiden van de verdere verwerking. Je hoeft je bij het toevoegen van content niet druk te maken over waar het komt of over technische details. Je kunt je bijdrage gewoon typen met Joomla via frontend-editing — net zoals bij elk ander Joomla-artikel. In een volgende fase nemen anderen de verwerking over.
Hoe bijdragen?
-
Maak een account aan op de sandbox-site. Het bevestigingsmailtje komt soms niet aan — geen zorgen, het komt goed na de volgende stap. Tip: gebruik dezelfde gebruikersnaam als je GitHub-account, dan kun je later ook met GitHub inloggen.
-
Kom naar het kanaal Documentation Suggestions op Mattermost en vraag om schrijfrechten. Vermeld je gekozen loginnaam.
-
Na het verkrijgen van auteursrechten kun je inloggen.
-
Bekijk de to-do-lijst op GitHub: github.com/joomla/documentation/issues. Heb je een GitHub-account, geef dan aan dat jij aan een onderwerp werkt (zo voorkom je dubbel werk). Vragen of discussie over je onderwerp kun je daar ook kwijt. Geen GitHub? Meld het dan gewoon op Mattermost.
-
Begin met schrijven! Je concept wordt pas zichtbaar nadat je het indient voor beoordeling. Waar het geplaatst wordt, is niet jouw zorg — dat regelt het team van “Documentation Curators”.
We gebruiken GitHub voor communicatie over documentatie. Zonder account kun je alleen lezen, niet deelnemen. Een account is zo aangemaakt en handig voor allerlei bijdragen aan Joomla, zoals het testen van bugfixes.
Voor nu focussen we op Engelstalige inhoud. Vertalingen volgen later automatisch (met menselijke controle), via Cliff’s ervaring met JDocManual. Dus op dit moment zoeken we geen vertalers.
Test je onderwerp eerst zelf uit. Zelfs als je iets fout doet, is dat waardevol — je leert ervan en anderen ook.
1. Bijdragen verwerken, structuur en kwaliteit bewaken
We willen initiële bijdragers niet vermoeien met details zoals plaatsing of finetuning. Daarvoor hebben we een team van Documentation Curators. Zij verwerken bijdragen, bewaken structuur en zorgen voor kwaliteit. We geven training en begeleiden je in deze rol. In korte tweewekelijkse meetings stemmen we af.
URGENT!@
We zoeken dringend twee mensen die ~1 uur per week willen helpen! Er komen nu bijdragen binnen, maar we hebben onvoldoende capaciteit om ze te verwerken. Dit is een echte bottleneck. Je kunt je technische schrijfvaardigheid verbeteren en samenwerken aan een zichtbaar en waardevol resultaat: uitstekende gebruikershandleidingen. Een mooie kans om trots te presenteren bij de release van Joomla 6 in oktober!
Interesse? Neem contact op met Herman Peeren via Mattermost. Dankjewel voor je overweging!
2. Implementatie en onderhoud
De afgelopen jaren is veel tijd besteed aan het zoeken naar de beste manier om documentatie te implementeren. Nu willen we ons vooral richten op het verbeteren van de inhoud. Maar daar zijn ook enkele praktische stappen voor nodig. Daarom zoeken we voor de komende maanden mensen die willen helpen bij verbeteringen aan Joomla-functionaliteiten zoals:
-
Workflow: We gebruiken Joomla's workflow. We willen dit bruikbaarder maken, bijvoorbeeld:
-
notificaties bij transities
-
plugin om zichtbaarheid van artikelen te wijzigen
-
automatische instellingen bij plaatsing van artikelen
(dezelfde behoeften gelden voor het Joomla Magazine en de Enhanced Guided Tours site)
-
-
Versiebeheer: We gebruiken Joomla's versiebeheer, maar het verschilscherm kan beter. We denken ook aan integratie van GitHub-versiebeheer binnen Joomla.
-
Websitebeheer: We zoeken een webmaster voor:
-
regulier onderhoud zoals updates/backups
-
CSS-aanpassingen/overrides voor betere menuweergave in het gebruikte joomla.org-template
-
Het zijn concrete, afgebakende taken — ze slokken je tijd niet structureel op.
Wie wil helpen?
Laat me weten als je een visuele samenvatting, how-to voor bijdragen, of Mattermost introductie nodig hebt.
Dit artikel werd oorspronkelijk gepubliceerd in het Joomla Community Magazine.
Lees alle artikelen in het magazine via deze link
Joomla! bestaat al 19 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.