Gentoo Linux Wiki:Stijl Richtlijnen
Uit Gentoo Linux Wiki
Gentoo Wiki artikelen zijn vooral "howto" artikelen waarin instructies worden gegeven voor het installeren, configureren en gebruiken van soft en hardware.
Inhoud |
[bewerken] Taalgebruik
Artikelen moeten in het Nederlands geschreven zijn. Technische termen moeten zo veel mogelijk ontweken worden, waar dit niet kan moeten deze gedefinieerd worden. Dit mag op een directe manier alsook het linken naar een andere pagina.
Artikelen moeten in de derde persoon geschreven worden. Dus geen "Ik" maar altijd refereren naar de lezer met "jij".
[bewerken] Stijl
Artikelen moeten duidelijk en helder zijn. Het doel van de wiki is informatie verschaffen, niet om mooi te zijn. Afbeeldingen moeten niet gebruikt worden om een artikel de decoreren.
[bewerken] Opmaak
Artikelen moeten minimaal de volgende onderdelen bevatten, in de hier weergegeven volgorde.
- Een samenvatting van het artikel of onderwerp
- Het doel van het artikel, met eventueel links naar andere gerelateerde artikelen.
- Begeleid de lezer stap voor stap door het proces, leg uit wat de opdrachten doen.
- Een onderdeel problemen en oplossingen. Laat hiet de oplossigen van de meest voorkomende problemen zien
- Lijst van gerelateerde artikelen, zelfs als deze al in het artikel voor zijn gekomen. Deze lijst kan ook links naar externe sites bevatten.
[bewerken] Hardware Artikelen
Bij een hardware artikel moet ook de volgende informatie gegeven worden:
- Waar nodig, de output van "lspci -nn" of "lsusb" van het betreffende apparaat.
- Alternatieve namen waaronder het product verkocht wordt. Met nadruk geen lijst van alle apparaten (bijv. laptops) waarin het product gebruikt wordt (bijv draadloze chipset).
[bewerken] Discussies
Discussies vinden alleen plaats in de "Overleg" pagina's, niet in de artikelen zelf
