Nederlandstalige Gentoo Wiki:Toch een paar regels

Uit Gentoo Linux Wiki

Omdat dit een wiki is, zijn er geen redacteuren. We moeten erop vertrouwen dat we met elkaar goede gewoonten ontwikkelen en af en toe iemand een duwtje in de goede richting geven. Maar het kan ook helpen een lijstje te maken van een aantal regels die al handig zijn gebleken, of die bruikbaar lijken. Hier is zo'n lijstje.

Je kunt je commentaar, afwijzing, instemming met bepaalde regels hier ook kwijt. Worden het uitgebreide discussies, dan kunnen we er altijd nog aparte pagina's voor aanmaken.

[bewerken] Echte regels

[bewerken] Voorgestelde Regels

• Negeer alle regels : Als regels je nerveus maken en je 't plezier ontnemen, negeer ze dan maar, gebruik je gezonde verstand en voel je vrij en ga je gang. Aanvaard dan echter wel dat er misschien discussie of protest komt. Accepteer altijd dat je pagina's door anderen aangepast of zelfs verwijderd worden als ze niet aan de echte-regels voldoen.

• Houd je aan het doel : Het doel van de Gentoo Wiki is om goed gestructureerde, duidelijke, correcte en volledige documentatie te leveren voor de Gentoo Linux distributie die ook nog up to date is.
  Alles wat je schrijft/plaatst moet dit doel benaderen. Dit doel klinkt niet eenvoudig, maar denk eraan dat anderen je artikels nog verbeteren en dat het dus nog niet perfect moet zijn. Maar plaats ook geen artikel over de lokale slager-om-de-hoek, want dit houd zich helemaal niet aan het doel, het heeft in de verste verte niets met Gentoo te maken en zal dus vrij snel op de Verwijderlijst terecht komen. In het algemeen mag je stellen dat alle artikelen die iets met gentoo of toch iets met informatica te maken hebben hier wel mogen staan.

• Het artikel hoeft niet af te zijn : Wees niet bang om te beginnen aan een onderwerp waarover je niet alles weet. Datgene wat je weet en beschrijft is een goed Beginnetje. Zelfs al zijn het maar twee of drie zinnen. Doordat je aan een artikel begint, worden anderen aangespoord het aan te vullen. Een artikeltje bestaande uit niets anders dan een slecht geformuleerde zin zal echter vrij snel genomineerd worden voor verwijdering.

• Verklaar jargon met links: Waneer je een artikel schrijft waar je bijvoorbeeld het woord DHCP schrijft, leg dan niet in de tekst zelf uit wat DHCP is, denk er aan dat de meeste lezers van de Gentoo Wiki al een goede informatica voorkennis hebben. Wat je wel best doet is een interne link van elke term maken. Een lezer die de term kent kan gewoon doorlezen en de anderen kunnen de link volgen om eerst te zien wat de term betekent en dan jouw artikel verder te lezen.
  Externe links zijn af te raden, het is makkelijker voor de lezer als hij steeds in de Gentoo Wiki blijft, dan blijf de layout en dergelijke steeds gelijk.
  Trek je er niets van aan als er nog geen artikel bestaat over een term die je gebruikt, jij of iemand anders kan dat later altijd schrijven.

• Toevoegingen integreren: Wanneer je iets aan een tekst toevoegt of verandert, zet je bijdrage dan op de juiste plaats (niet als aparte opmerking of intentie onderaan). Zorg er dan alsjeblieft voor dat de tekst vloeiend blijft doorlopen en één geheel vormt met de originele tekst. Gentoo Wiki artikelen moeten uiteindelijk geen bonte verzameling van losse opmerkingen worden, maar een naadloos geheel, wat altijd nog kan worden uitgebreid.

• Verwijder klinkklare onzin: Duidelijke nonsens moet worden verwijderd. We kunnen erover van mening verschillen wat klinklare onzin enzo is, dus wees er wel voorzichtig mee. Twijfel je, overleg dan eerst met andere deelnemers.

• Lees eerst de overleg-pagina: Indien er een overleg-pagina is bij een artikel, lees deze dan eerst voor je het artikel aanpast. Hier staan soms discussies tussen de verschillende auteurs over waarom ze een bepaald stuk op een bepaalde manier hebben geschreven of waarom sommige dingen niet of juist wel in dit artikel staan.
  Soms staan hier ook vragen van lezers die niet beantwoord worden in het artikel. Als je het antwoord kent kan je dit verwerken in het artikel of gewoon op de overleg-pagina zelf beantwoorden als je denkt dat het antwoord niet in het artikel thuishoort.

• Schrijf ook op de overleg-pagina: Als je na het lezen van een artikel nog vragen hebt, stel deze dan op de overleg-pagina. Het kan goed zijn dat ze na verloop van tijd beantwoord worden in het artikel of op de overleg-pagina.
  Als je iets verandert of schrijft waarvan je denkt dat anderen zich gaan afvragen waarom je dit op een bepaalde manier doet, leg het dan uit op overleg-pagina.

• Beperk externe links & schrijf niets dubbel: Check altijd eerst of iets niet in Gentoo Wiki wordt uitgelegd in een artikel voor je een externe link maakt.
  Voor je iets schrijft kan je best ook altijd eerst checken of iemand anders hetzelfde al niet uitlegd in een ander artikel.Niemand heeft er iets aan als we 5x ongeveer hetzelfde artikel onder een andere naam hebben.
  Je kan toch zoeken ?
  

• Citeer je bronnen: Wanneer er bij het schrijven of onderbouwen van een artikel gebruik is gemaakt van externe bronnen, zorg dan voor een literatuurlijst (boeken en artikelen, zowel als webpagina's). Dit is niet alleen intellectueel eerlijk, maar het wijst lezers bovendien de weg naar nog meer informatie. Uiteraard neem je niet klakkeloos tekst en/of afbeeldingen over van beschermde bronnen met auteursrechten.

• Maak spaarzaam gebruik van multimedia: Denk eraan dat sommige lezers surfen met browers als lynx of links die in de console draaien en geen prentjes,geluiden,... kunnen weergeven. Probeer er voor te zorgen dat ook zij de Gentoo Wiki kunnen lezen.

• De lezers zijn niet idioot: Het dient nergens toe om van alle mogelijke woorden een link te maken. De lezers weten echt wel wat een computer of internet is, van zo'n woorden moet je echt geen interne links maken.

• Herhaal links niet te vaak: Maak per artikel niet meer dan één of twee maal (per schermpagina) dezelfde link, ook al staat hetzelfde begrip of woord er wel twintig keer in. Groepeer additionele links onderaan de pagina en maak er een aparte sectie van. Probeer niet te veel, maar ook zeker niet te weinig links aan te maken in je tekst (de kracht van documentatie op het web is vooral het snel kunnen doorklikken naar een mogelijk interessant ander onderwerp)

• Check wat je schrijft: Zorg er voor dat je niet liegt in je artikel, check alle procedures die je beschrijft. Je wilt toch niet dat iemand heel zijn harde schijf verliest omdat jij het partioneren verkeerd uitlegt ?
  Getallen kunnen best ook goed gecheckt worden, de meeste mensen nemen het voor waarheid aan als je zegt dat er bij de start van Gentoo X aantal ebuilds in portage zaten, zelf al zaten er 5x zoveel in. Een fout in een getal wordt niet snel gevonden en dus ook niet snel verbeterd.

• Groepeer de behandelde onderwerpen: Het mensenbrein kan waarschijnlijk maximaal zeven dingen tegelijk verwerken. Ellenlange eentonige lijsten, eindeloos doorrammelend proza en monsterlijk lange zinnen missen daarom hun doel en zijn bovendien heel vervelend om te lezen. Maak rustig een lijst van te behandelen sub-onderwerpen, maar deel die lijst op in groepen, sub-groepen en paragrafen. En gebruik zo weinig mogelijk ingewikkeld samengestelde zinnen.

• Wees niet bang om te verbeteren: Dit is een wiki, als je iets wilt verbeteren, doe het dan ! Hiermee bedoel ik niet alleen de inhoud zelf maar ook de layout van het artikel, de zinsstructuur en spellings fouten

• Aanvaard dat anderen jouw teksten verbeteren: Als iemand jouw tekst verbetert, wordt dan niet boos maar aanvaard het als het beter is. Als je het slechter vind lees dan eerst de overlegpagina en verander het dan terug in het origineel als je dat beter vond. Schrijf dan wel zeker in de overleg-pagina waarom je de nieuwe versie slecht vindt !

• Schep evenwicht: Schep evenwicht in je artikel. Evenwicht in de lengte van de paragrafen, evenwicht in de behandeling van onderwerp, argumenten en tegenargumenten. Maak evenwichtig gebruik van (open) bronmateriaal en geef niet tien citaten van iemand die één van de bestaande meningen over een onderwerp vertegenwoordigt en maar één van zijn/haar opponent. Een artikel van drie zinnen met een literatuurlijst van dertig boeken is ook niet in evenwicht. Dat laatste is bij de eerste opzet van een artikel wellicht ook niet relevant.

• Vermijd tijdgebonden uitspraken: Uitdrukkingen die je moet vermijden zijn bijvoorbeeld 'kortgeleden', 'hedentendage', 'gisteren', 'is momenteel van mening', 'binnenkort', 'de zestiger jaren', 'huidige', 'tegenwoordig' en dergelijke. Stel je eens voor dat over 80 jaar iemand jouw artikel onder ogen krijgt, zijn dat soort uitdrukkingen dan nog relevant? Uitzondering op deze regel zouden artikelen over langdurige processen kunnen zijn, die regelmatig moeten worden ververst, bijvoorbeeld een oorlog, of verkiezingen. Gebruik in plaats van deze term gewoon het jaartal. Schrijf niet: het aantal gebruikers van Gentoo is momenteel 12.000, maar: het aantal gebruikers van Gentoo is in 2004 12.000.

• Vermijd plaatsgebonden uitspraken: Realiseer je dat de Gentoo Wiki zowel Nederlandse als Vlaamse gebruikers heeft, en dat bijvoorbeeld een vermelding als Ons land heeft de volgende providers verwarring kan veroorzaken.

• Benoem een pagina zorgvuldig: Als de pagina de juiste naam heeft, is het eenvoudiger om die te vinden en is het makkelijker om naar een pagina te verwijzen. Gebruik volledige namen, geen afkortingen als artikel-titels. Wat wel aangeraden is,is van de afkorting een redirect maken naar de echte naam.
  Maak van de eerste letter een hoofdletter en begin woorden die alleen in de informaticawereld gebruikt worden ook een hoofdletter.

• Let op de spelling, speciaal die van een nieuwe paginatitel: Zo vermijd je onnodige verplaatsingen (redirects) en voorkom je verwarring en het missen van je onderwerp bij een zoekopdracht. Ben je geen kei in spelling, dan zou je je tekst wellicht in een tekstverwerker kunnen schrijven en de spellingsfunctie erop loslaten, voordat je de tekst met kopiëren/plakken naar de Gentoo Wiki verplaatst.