Paginainrichting betekent verschillende dingen voor verschillende mensen, maar hier zal het de toepassing van typografie en opmaak betekenen zoals je die ziet in professioneel ontworpen documenten.
Onze focus hier ligt op technische documentatie, wat bescheiden, functioneel ontwerp impliceert.
Voor nog meer details dan je hier ziet, raadpleeg deze twee standaard industriebronnen:
- Sun technische publicaties. Lees Eerst! Elke recente editie. Prentice Hall.
- Microsoft Corporation. Microsoft Handleiding voor Stijl bij Technische Publicaties. Elke recente uitgave. Microsoft Press.
Koppen en Voetteksten
Mensen verwarren vaak koppen met titels. Titels, behandeld in koppen zijn die zinnen aan de orde binnen het lichaamsgebied van een document. Koppen zijn die zinnen en mogelijk paginanummers die voorkomen binnen het kopgebied van een document. Voetteksten zijn die zinnen en mogelijk paginanummers die voorkomen binnen het voettekstgebied van een document. Een veelgemaakte fout, en een grote, is om de titel van een document in het kopgebied te plaatsen, wat ertoe leidt dat deze bovenaan elke volgende pagina verschijnt.
Bekijk een diagram van een typische documentpagina:
Een veelvoorkomend pagin ontwerp is om de documenttitel en het paginanummer in het voettekstgebied te plaatsen. In een afwisselend formaat kan de linkerpagina het paginanummer en de documenttitel tonen, in die volgorde; de rechterpagina kan de documenttitel en het paginanummer tonen, in die volgorde.
Koppen
Het volgende presenteert enkele van de standaardrichtlijnen over koppen. Voor een gedetailleerdere discussie, zie het hoofdstuk over koppen in het online handboek.
- Gebruik ruime kopjes, misschien één kopje voor elke twee tot drie alinea's. Natuurlijk kunnen kopjes ook te veel zijn: veel kopjes met slechts één of twee zinnen per kopje werkt niet.
- Ontwerp koppen zodat ze duidelijk hun niveau aangeven. Gebruik lettergrootte, letterstijl, kleur, vetgedrukt, cursief, uitlijning op een zodanige manier dat het niveau van de kop vanzelfsprekend is. ("Niveaus" van koppen zijn als niveaus in een schema: het eerste niveau komt overeen met de Romeinse cijfers; het tweede niveau met de hoofdletters; enzovoort.)
- Maak koppen die beschrijvend zijn voor de secties die ze introduceren. Koppen zoals "Technische Achtergrond" zeggen niemand iets.
- Maak koppen parallel in formulering. Parallelisme geeft de lezer belangrijke aanwijzingen over de vraag of de sectie vergelijkbaar van aard is met de voorafgaande.
- Vermijd "eenzame koppen"—het is hetzelfde concept als het hebben van een "A" zonder een "B" of een "1" zonder een "2" in schema's.
- Vermijd "opgestapelde koppen"—dat zijn twee of meer opeenvolgende koppen zonder tussenliggende tekst.
- Vermijd het verwijzen naar koppen met voornaamwoorden in de tekst die volgt op de koppen. Als er een kop is zoals "Het Configureren van de Software," volg deze dan niet met een zin zoals "Deze volgende fase..."
- Overweeg het gebruik van het "hanging-head" formaat om koppen meer op te laten vallen en om de lengte van gewone tekstregels te verkorten. In het hanging-head ontwerp staan enkele of alle koppen aan de linker marge, terwijl de hele tekst één tot twee inch is ingesprongen.
- Overweeg om "doorlopende" koppen te gebruiken voor je laagste kopniveau. Het kan moeilijk zijn om uitsluitend op lettertype en -grootte te vertrouwen om kopniveaus aan te geven. Een doorlopende kop "loopt in" het begin van een alinea en eindigt met een punt. Je kunt een combinatie van vet, cursief of kleur voor deze koppen gebruiken.
Lijsten
Lijsten zijn nuttige hulpmiddelen om belangrijke punten te benadrukken, snelle scanning van tekst mogelijk te maken en meer witruimte te bieden. Het volgende presenteert enkele van de standaardrichtlijnen voor lijsten. Voor een meer gedetailleerde bespreking, zie het hoofdstuk over lijsten.
- Gebruik genummerde lijsten voor items die in een vereiste volgorde staan of die met een nummer moeten worden aangeduid. Gebruik opsommingstekens voor items die geen vereiste volgorde hebben.
- Gebruik de standaard genummerde en opsommingslijstformaten die beschikbaar zijn in de alinea-stijlen van tekstverwerkingssoftware, HTML-tags en andere.
- Maak de formulering van lijstitems. parallel.
- Introduce alle lijsten met een inleiding; gebruik geen koppen als inleidingen voor lijsten.
- Tenzij de stijl van uw organisatie anders aangeeft, punctueer lijstitems met een punt alleen als ze complete zinnen zijn of ingesloten afhankelijke zinnen bevatten.
- Gebruik ofwel een hoofdletter of kleine letters voor het eerste woord van lijstitems, maar doe dit consistent.
- Voor geneste lijsten, gebruik een vetgedrukte en-streep voor het opsommingsteken in tweede niveau lijstitems; gebruik kleine letters voor tweede niveau genummerde lijstitems. Zorg ervoor dat geneste items uitlijnen met de tekst of het vorige niveau.
- Vermijd overmatig gebruik van lijsten of lijsten met te veel items. Zeven tot tien items wordt meestal als het maximum voor lijsten beschouwd.
Kennisgevingen
Kennisgevingen zijn die speciaal opgemaakte tekstfragmenten die lezers waarschuwen voor speciale punten, uitzonderingen, potentiële problemen of gevaar. Het volgende presenteert enkele van de standaardrichtlijnen voor kennisgevingen. Voor een meer gedetailleerde bespreking, zie het hoofdstuk over kennisgevingen.
- Gebruik een standaard hiërarchie van meldingen waarin meldingen prominenter en opvallender worden naarmate ze ernstiger worden.
- Overweeg deze hiërarchie te gebruiken:
- gevaarwaarschuwingen voor situaties waarbij potentieel ernstig letsel of overlijden kan optreden
- waarschuwingen voor situaties met lichte verwondingen
- voorzorgen voor situaties met schade aan apparatuur of gegevens of dreiging voor het succes van de procedure
- opmerkingen voor punten van uitzondering of benadrukking die niet betrekking hebben op de voorafgaande situaties.
- Welke meldingsontwerpen je ook gebruikt, vermijd uitgebreide tekst in helemaal vet, helemaal cursief, all-caps of combinaties daarvan.
- Naast het vertellen aan lezers wat ze wel of niet moeten doen, leg uit wat er zal gebeuren als ze de waarschuwing negeren, onder welke omstandigheden de verklaring nuttig is en hoe ze zich kunnen herstellen als de verklaring wordt genegeerd.
- Maak de tekst van mededelingen beknopt, maar niet ten koste van duidelijke schrijfstijl. Vermijd een telegraphische schrijfstijl (weglating van artikelen zoals a, een, de) in kennisgevingen.
- In genummerde lijsten, alineer meldingen naar de tekst van het lijstitem waartoe ze van toepassing zijn.
- De standaardwijsheid van het plaatsen van meldingen voor de stap waarin het potentiële probleem zich bevindt kan problemen veroorzaken in de opmaak. Geef indien mogelijk waarschuwingen, voorzorgen of gevaren aan het begin van de gehele procedure.
Cijfertjes
Figuur zijn alle soorten illustraties, tekeningen, schema's, foto's enzovoort. Zie grafieken voor een gedetailleerde discussie. Intussen zijn hier enkele belangrijke punten:
- In de tekst voor de afbeelding, geef een kruisverwijzing naar de afbeelding.
- Hoewel het niet absoluut noodzakelijk is om een figuurtitel (bijschrift) voor elke figuur op te nemen, plaats het dan beneden de figuur.
- Bijvoorbeeld, in instructies wanneer de afbeeldingen nauw verbonden zijn met de individuele stappen, hebben figuurtitels geen vitale functie en zijn ze niet nodig.
Tabellen
Tabellen zijn als verticale lijsten, die eerder zijn besproken, maar gestructureerder en formeler. Zoek in je tekst naar herhaalde paren, drievoudige of viervoudige items die als tabellen kunnen worden opgemaakt. Bijvoorbeeld, een reeks termen en definities is een klassieke toepassing voor tabellen. Hieronder worden enkele van de standaardrichtlijnen voor tabellen gepresenteerd. Voor een meer gedetailleerde bespreking, zie het hoofdstuk over tafels.
- Zoek naar herhalende groepen van items in jouw tekst die je als tabellen kunt opmaken.
- In de tekst voor de tabel, geef een kruisverwijzing naar de tabel.
- Gebruik een tabeltitel tenzij de inhoud van de tabel volkomen duidelijk is en de tabel weinig items bevat. Plaats de tabeltitel boven de tabel, of maak het de bovenste rij van de tabel.
- Gebruik kolom- en rijkoppen (of beide) om de inhoud van de kolommen en rijen te definiëren. Overweeg om een soort markering te gebruiken voor deze kolom- en rijkoppen.
- Links uitlijnen tekstkolommen (tenzij ze eenvoudige alfabetische tekenitems zijn). Links uitlijnen tekstkolommen met hun koppen.
- Lijn numerieke gegevens rechts of decimaal uit en center het onder zijn kop.
- Plaats standaard meeteenheden (ft, mm, gal.) in de kolom- of rijkop in plaats van bij elk item in de kolom of rij.
- Geef een korte bespreking van de belangrijkste trend in de tabel—wat je wilt dat de lezers opmerken.
Markering
Softwaredocumentatie gebruikt doorgaans veel nadruk. Nadruk verwijst hier naar vetgedrukt, cursief, alternatieve lettertypen, hoofdletters, aanhalingstekens en andere typografische trucs die worden gebruikt om de aandacht op tekst te vestigen. Het volgende presenteert enkele standaardrichtlijnen voor nadruk. Voor een meer gedetailleerde bespreking, zie het hoofdstuk over markeren.
- Stel een plan op voor het gebruik van markeren en pas het consequent toe. Gebruik markeren voor specifieke, functionele redenen. Vermijd te veel markering; vermijd ingewikkelde markeer-schema's.
- Overweeg om dit vrij standaard markering schema te gebruiken:
- Voor eenvoudige nadruk, gebruik cursief.
- Gebruik **vetgedrukte** letters voor commando's, knoppen op het scherm en menuopties.
- Gebruik cursief voor variabelen waarvoor gebruikers hun eigen woorden moeten invoeren.
- Gebruik een ander lettertype voor tekst die op het scherm wordt weergegeven of tekst die gebruikers moeten typen.
- Gebruik de hoofdlettergebruikstijl die op het scherm wordt weergegeven voor scherm- en veldnamen, maar geen andere markering.
- Gebruik een initieel hoofdletter voor sleutelnamen maar geen andere marking.
- Voor uitgebreide nadruk, gebruik het notificatieformaat.
Marges, Inspringing & Uitlijning
Zoals vermeld in de sectie over koppen, is het een mooie touch om tekst één tot twee inch in te laten springen terwijl de koppen aan de linkermarge blijven. Deze stijl doet twee dingen: het laat de koppen opvallen en verkort de regel lengte van gewone tekst.
Lettertypen & Kleur
Hier zijn enkele suggesties met betrekking tot lettertypen en kleur:
- Gebruik slechts één alternatieve lettertype, maximaal twee. Bijvoorbeeld, je kunt Arial gebruiken voor koppen, Times New Roman voor de hoofdtekst, en Courier New voor tekst die op het scherm wordt weergegeven of die gebruikers moeten typen.
- Als je kleur gebruikt, doe dit dan minimaal. Bijvoorbeeld, als je zwarte tekst op een witte achtergrond hebt, kun je een andere kleur voor koppen kiezen. Je kunt dezelfde kleur gebruiken voor figuur- en tabeltitels, evenals de labels voor waarschuwingen (de feitelijke "Opmerking," "Waarschuwing," "Voorzichtig," en "Gevaren" labels op kennisgevingen).
- Vermijd ongewone combinaties van achtergrond- en tekstkleuren. Bijvoorbeeld, paarse of rode tekst op een zwarte achtergrond is vreselijk om te lezen. Houd je aan zwarte tekst op een witte of grijze achtergrond, tenzij er een sterke functionele reden is voor een andere kleurcombinatie.
Ik zou uw gedachten, reacties en kritiek op dit hoofdstuk op prijs stellen: je reactie.
