DokuWiki

It's better when it's simple

Gebruikershulpmiddelen

Site-hulpmiddelen


Zijbalk

Deze vertaling is ouder dan de originele pagina en kan verouderd zijn. Kijk wat er is veranderd.
Vertaling van deze pagina?:

Leer over DokuWiki

Geavanceerd Gebruik

Bedrijfsmatig Gebruik

Onze Gemeenschap


Volg ons op Facebook, Twitter en andere sociale networken.

nl:tips:good_style

Hints over goede stijl

Hier zijn een paar aanwijzingen voor het schrijven van wiki-pagina's in een goede stijl.

Paginastructuur

  • Begin je pagina met een heading van het hoogste nivo met een betekenisvolle titel
  • Deel je tekst in in paragrafen door er lege regels tussen te laten. Een gemiddelde paragraaf zou niet langer moeten zijn dan 10 tot 20 regels.
  • Als je tekst langer is dan een paar (3 tot 5) paragrafen, overweeg dan om de tekst op te delen in secties door tweede tot vijfde nivo headings.
  • Zet een korte samenvatting van de pagina onder de eerste heading als je tekst langer wordt dan 2 tot 3 pagina's
  • Voeg een speciale sectie met referenties toe (zie hieronder), als je veel links naar andere wiki-pagina's of externe bronnen gebruikt.
  • Vaak delen pagina's binnen een namespace dezelfde structuur, voeg in dat geval een namespace template toe, zodat nieuwe pagina's daarmee kunnen beginnen.
  • Voorkom veel te ingewikkelde namespacestructuren. Probeer korte en makkelijk onthoudbare namespacenamen te gebruiken

Tekstopmaak

  • Leg nadruk op woorden door ofwel vetgedrukt ofwel schuingedrukt te gebruiken. Kies er 1 van en gebruik dit consequent.
  • Kies een consequente stijl om schermuitvoer, knoppen en menu-labels weer te geven. Het is waarschijnlijk een goed idee om een uitleg van die stijlconventies toe te voegen aan je wiki.
  • Gebruik niet-genummerde lijsten voor opmerkingen die los van elkaar staan.
    Als je een manier van denken probeert te ontwikkelen bij de lezer, is een continue reeks van zinnen beter.
  • Gebruik voetnoten spaarzaam en alleen voor korte opmerkingen. Als er veel meer te vertellen is over een onderwerp, maak dan een nieuwe wiki-pagina. Als je wilt refereren aan (externe) informatiebronnen, kun je beter links gebruiken.
  • Tabellen kunnen de leesbaarheid van gestructureerde data enorm vergroten. Als je een tabel invoegt, zorg dan dat deze betekenisvolle koppen gebruikt en zet er een samenvattende tekst bij die de inhoud van de tabel omschrijft (Bijv.: “Tabel 1.2 Gemiddelde afstanden tusen de planeten”)

Taalgebruik

  • Schrijf correcte zinnen en gebruik lidwoorden bij zelfstandige naamwoorden indien nodig.
  • Start elke zin met een hoofdletter en eindig met een punt, of andere toepasselijke punctuatie.
  • Probeer korte heldere zinnen te schrijven zonder veel bijzinnen. Als je denkt dat je pagina af is, lees hem dan nog eens door en herschrijf de zinnen die te gecompliceerd zijn.
  • Bepaal hoe je jouw lezers aanschrijft. Aangezien DokuWiki ontworpen is om documentatie in te schrijven zul je regelmatig je lezers instructies moeten geven. Je kan gebiedende wijs gebruiken (“Doe dit!”), de wij/jij vorm (“Dan klikken we op…” / “Dan klik je op…”) of de ik vorm (“Ik voeg dan de foo bij de bar, gebruik makend van…”). Gebruik deze vormen niet door elkaar. (Vreemd genoeg is deze regel een fout voorbeeld)
  • Controleer je pagina op grammaticale fouten en spellingsfouten voordat je hem opslaat. Als er veel fouten in je tekst staan verlaagt dat de geloofwaardigheid van de inhoud, ongeacht hoe goed bedacht of correct die inhoud is.
  • Ontwikkel je eigen stijl. Dwing jezelf niet om te schrijven op een manier die je niet prettig acht. Je tekst zal alleen maar onnatuurlijk overkomen, en onprettig zijn om te lezen.

Referenties

  • Als je een term tegenkomt die meer uitleg vergt, maak dan een nieuwe wiki-pagina voor die term en link er naar toe.
  • Controleer je pagina voordat je hem gereed verklaart, en voeg links toe naar bestaande wiki-pagina's voor de belangrijkste termen op je pagina.
  • Voeg niet voor elk voorkomen van een term een link toe. Maak van de eerste en/of meest prominente een link en voeg misschien een link toe naar de referenties sectie.
  • Voorzie in links naar de bronnen van plaatjes, data en quotes.
  • Overweeg om een “Zie ook:” regel aan het eind van je pagina toe te voegen. Voorzie daar in links naar wiki-pagina's die dicht gerelateerd zijn aan het onderwerp van jouw pagina.
  • Als je wilt verwijzen naar externe bronnen die meer informatie over jouw onderwerp hebben of die je hebt gebruikt bij het schrijven van je pagina, voeg dan een sectie “Referenties” of “Meer informatie” toe aan het eind, en geef een lijst met links of andere aanwijzingen (bijv. ISBN nummers). Als je dat in de hoofdtekst nog niet gedaan hebt, voeg dan ook de bedoeling van de referentie toe (bijv: “[site] heeft meer hints over hoe je moggels een sproetje op transploft kan laten doen.”)

Plaatjes en andere media

  • “Een foto zegt meer dan duizend woorden.” Het kan zelfs meer zeggen dan je bedoelde te zeggen. Mensen hebben de neiging om plaatjes meer te geloven dan tekst. Een korte tekstbeschrijving is beter dan niks en beter dan een slecht plaatje.
  • Zorg, net als bij tabellen, voor een korte samenvatting bij plaatjes, die weergeeft wat je wilt laten zien met dat plaatje (bijv: “Afbeelding 3.2: Amateur-fotograaf met een frubbel die een wubbel in een gubbel verborbelt.”)
  • Als je het plaatje niet zelf maakte, vermeldt dan de bron (mogelijk met link) en het copyright.
  • Gebruik plaatjes niet rechtstreeks van externe sites, tenzij je expliciete toestemming hebt. Het verbruikt namelijk bandbreedte van de site waar het plaatje staat. Upload het plaatje naar de wiki, als je kan.
  • Gebruik een link met resize instructies om een thumbnail in te voegen, als het plaatje groter is dan ongeveer eenderde van een schermpagina.
nl/tips/good_style.txt · Laatst gewijzigd: 2014-05-15 14:38 door Klap-in