Help:Redactie/Publicaties

Structuur

Inleiding

Na het lezen van de inleiding moet de lezer weten of deze publicatie interessant is voor hem/haar. In de inleiding introduceer je ook enkele belangrijke begrippen. Verwijs indien nodig naar standaarden, richtlijnen, glossariumtermen of software.

Inhoudstafel

Serveer je publicatie in hapklare brokken:

• Verdeel de inhoud in logische stappen die niet te algemeen zijn, zodat het overzicht concreet blijft.
• Gebruik in je titel een infinitief om de actie aan te geven, maar vermijd ‘het … van’ (zie stijlgids).
• Streef naar inhoudelijke samenhang per onderdeel.
• Vergeet aan het einde ook niet je bibliografie toe te voegen indien van toepassing.

Inhoud

Hou de volgende zaken in gedachten:

• Hou het luchtig: gebruik alinea’s van maximaal zes regels.
• Gebruik betekenisvolle tussentitels.
• Het W3C houdt er niet van dat tabellen gebruikt worden voor opmaakdoeleinden. Vermits CEST de scheiding van inhoud en opmaak expliciet vermeldt als aanbevolen richtlijn, vermijden we dit zo veel mogelijk.
• Je kunt je instructies zowel in doorlopende tekst als in lijstjes plaatsen. Vermijd evenwel willekeurig gebruik van lijstjes en van genummerde lijstjes.

Veelgestelde vragen

Zijn er vragen die vaak terugkomen? Dan kun je onderaan het overzicht een lijstje met veelgestelde vragen toevoegen. Probeer deze vragen eerst te verbinden met een bestaande pagina die het antwoord bevat. Als die niet bestaat, maak dan een nieuwe pagina.

Schrijftips

Publicaties schrijven is eigenlijk een vak op zich. Qua schrijfstijl zijn er specifieke eisen op tekst-, zins- en woordniveaus. Al deze eisen hebben hetzelfde doel: de publicatie zo helder en gebruiksvriendelijk mogelijk maken.

Zinsbouw

Ook op zinsniveau focus je op chronologie en helderheid. Vergelijk het onderstaande voorbeeld:

• Vink ‘transparante kleur aanduiden’ onderaan rechts in het ‘Opslaan’-venster.
• Open het ‘Opslaan’-venster. Vink onderaan rechts ‘transparante kleur aanduiden’ aan.

De eerste versie volgt niet het oog van de gebruiker en de logische volgorde van de handeling. Daarom is de tweede versie de betere.

Speciale gevallen

Handleidingen

Tekststructuur

Het perfecte voorbeeld van een handleiding is eigenlijk een recept:

• Eerst stel je de ‘ingrediënten’ voor. Op die manier raakt de lezer niet in de war in het midden van de handleiding.
• Dan volgen de instructies in exacte chronologische volgorde: de hoofdstukjes, alinea’s, zinnen en woorden.
• De instructies zijn gemakkelijk te volgen en helder:
  • Ze slaan geen stappen over, hoe overbodig die ook mogen lijken.
  • Ze zijn exact en laten daardoor zo weinig mogelijk ruimte voor interpretatie.
  • Geef geen twee instructies tegelijk. Je vermijdt dit bijna automatisch door enkelvoudige zinnen te gebruiken (zie stijlgids).
  • Instructies vertellen ‘hoe’, niet waarom. Soms staat wat achtergrondinfo in de inleiding, maar je vindt het nooit midden in een recept! Zo hoort het ook in een handleiding.

Woordkeuze

Uiteraard gelden hier alle regels voor woordkeuze die je terugvindt in de stijlgids. Let in het bijzonder op de volgende zaken:

• Gebruik geen synoniemen. Het is immers verwarrend voor de gebruiker dat je hetzelfde concept met verschillende woorden aanduidt, bv. ‘representatie’ en ‘afbeelding’.
• Pas je stijl aan. Een eenvoudige manier om te controleren of je schrijfstijl geschikt is voor een handleiding, is je inbeelden dat je naast gebruiker staat en de instructies mondeling geeft. Wedden dat je geen woorden als vervolgens, steeds, zulks, echter … gebruikt?
• Is er iets wat je aan diezelfde imaginaire gebruiker niet kunt verduidelijken zonder het te tonen? Dan heeft je handleiding hier wellicht een illustratie nodig!