Markering, zoals de term hier wordt gebruikt, is het gebruik van typografische effecten om aandacht te vestigen op tekst. Deze effecten kunnen schuin, vet, geheel in hoofdletters, aanhalingstekens, kleur, enzovoort omvatten. Markeringen trekken de aandacht van lezers—of "cues" ze"—voor acties die ze moeten ondernemen of informatie die ze zorgvuldig moeten overwegen.

Een van de problemen in technische schrijven—in het bijzonder, technisch schrijven over computers—betreft het gebruik van de verschillende technieken voor nadruk. Helaas gaan sommige technische teksten te ver in het gebruik van de verschillende nadruktechnieken die hier worden besproken.

De basisprincipes van markeren

Overweeg een paar fundamentele principes van nadruk:

In de volgende discussie zult u opmerken dat elk systeem van benadrukkingstechnieken vrij gecompliceerd en moeilijk te onthouden kan zijn voor schrijvers en redacteuren. U zult opmerken dat er veel even valide manieren zijn om benadrukkingstechnieken te gebruiken: in sommige gevallen is het willekeurig of je vet of cursief gebruikt voor eenvoudige nadruk. Om dit probleem aan te pakken, moet je je richtlijnen voor het markeren documenteren in een stijlhandleiding waar schrijvers en redacteuren (of alleen jij) naar kunnen verwijzen. Een stijlhandleiding is gewoon een registratie van de beslissingen die jij en jouw documentatieteam hebben genomen over hoe je wilt dat je documenten eruitzien.

Uw lezers moeten ook geïnformeerd worden over het markering-schema dat u van plan bent te gebruiken. Dit kan worden behandeld in de inleiding: voeg een sectie toe met de naam "Markering" of "Typografische Conventies" waarin u vermeldt hoe u cursief, vet, lettertypen en andere dergelijke effecten gebruikt. Voor een voorbeeld, zie de bespreking van inleidingen in het hoofdstuk over standaardonderdelen van technische boeken

Specifieke Benadrukkingstechnieken

Dit volgende gedeelte gaat één voor één door de verschillende benadrukkingstechnieken en legt de gebruikelijke praktijken uit.

Opmerking: Om het eenvoudig te houden, problemen benadrukken voor tafels, figuren, koppen, lijsten, en mededelingen worden gepresenteerd in die secties.

Vetgedrukt

In de publicatie, en vooral in technische publicaties, is het gebruik gemengd als het gaat om het gebruik van vetgedrukt of cursief voor basisemfase. Bijvoorbeeld, als je wilt benadrukken dat lezers de computer niet moeten uitschakelen zonder deze eerst af te sluiten, kan het "niet" vetgedrukt of cursief zijn. Traditioneel is cursief gebruikt, maar, misschien door computers, wordt ook vaak vetgedrukt gebruikt.

Welke techniek je ook gebruikt, gebruik deze consistent in je tekst of bibliotheek van gerelateerde teksten. Trouwens, lezers zullen waarschijnlijk niet in staat zijn om onderscheid te maken tussen niveaus van nadruk: bijvoorbeeld, het gebruik van cursief voor belangrijke tekst en vetgedrukt voor zeer belangrijke tekst zal waarschijnlijk aan de meeste lezers ontgaan.

Als je in de verleiding bent om een hele alinea vetgedrukt te maken, onthoud dan een van de principes van nadruk die hierboven zijn besproken: het gebruik van te veel van een techniek voor nadruk zorgt ervoor dat het effect van de techniek verloren gaat. Niet alleen dat, maar te veel nadruk maakt lezers minder geneigd om te lezen. In plaats van een volledig vetgedrukte alinea zorgvuldig te lezen, kunnen lezers deze helemaal negeren!

In plaats van een volledig vetgedrukt paragraf te maken, gebruik de speciale-mededeling formaat. Hierbij is een sleutelwoord (bijvoorbeeld, Belangrijk, Opmerking, Gevaar, Voorzichtig, Waarschuwing) vetgedrukt, terwijl de rest van de tekst in normale schreeflettertype is gelaten (dat wil zeggen, hetzelfde lettertype en dezelfde stijl als de reguliere hoofdtekst).

Legitiem gebruik van vetgedrukte tekst in technische teksten varieert sterk. Zolang je een schema ontwikkelt dat direct verband houdt met de behoeften van de lezer en de kenmerken van de tekst (of technologie) en dat niet leidt tot overkill, zou je gebruik van vetgedrukte tekst goed moeten werken.

Hier zijn enkele veelvoorkomende, standaardtoepassingen van vetgedrukt:

U zult opmerken dat de voorafgaande discussie geen absolute regels vermeldde. Dat is hoe het is—technische publicatiepraktijken zijn behoorlijk gevarieerd. Het belangrijkste idee is om een logisch, gecontroleerd systeem van markeren te ontwikkelen, dit consistent te gebruiken en het te documenteren in een stijlhandleiding, zodat u en uw documentatieteamleden ernaar kunnen verwijzen.

cursief

Hier zijn enkele standaard toepassingen voor cursief:

Onderschrijvingen

Er is bijna geen reden om underscores te gebruiken in technische tekst. In de tijd van getypte tekst was dat zeker het geval. Echter, in deze tijd, wanneer vetgedrukt, cursief en andere typografische effecten gemakkelijk beschikbaar zijn, lijken underscores verouderd. Als je iets wilt benadrukken, gebruik dan je standaard richtlijnen—bijvoorbeeld, gebruik cursief of vet. Probeer geen gradaties van nadruk te creëren: bijvoorbeeld, een schaal van toenemende belangrijkheid van cursief naar vet naar underscore zal verloren gaan op je lezers.

Als je goed gebruik van onderlijnen in technische teksten ziet, zal dat waarschijnlijk voorkomen in het ontwerp van koppen.

Hoofdletters

In technische publicaties lijkt er een voortdurende strijd te zijn tussen technische schrijvers en technische experts over hoofdletters. Technische experts gebruiken graag hoofdletters voor praktisch elk onderdeel en proces in een systeem. Ook gebruiken technische experts (en het management) doorgaans hoofdletters voor tekst die ze belangrijk vinden en waar ze willen dat lezers aandacht aan besteden. Ondertussen staan technische schrijvers en redacteuren (terecht) erop alleen hoofdletters te gebruiken voor eigennamen.

Als technisch schrijver, houd de lijn vast tegen kapitalisatie. Hoofdletters zijn afleidend; tekst in hoofdletters is oncomfortabel om te lezen. Hoofdletters creëren een drukke tekst, die veel onnodige signalen uitzendt. Hoofdletters zijn traditioneel bedoeld voor eigen namen zoals Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, enzovoort. De klassieke richtlijn in technische publicaties is om de namen van afzonderlijk bestelbared producten alleen. De politiek van organisaties buigt deze richtlijn aanzienlijk. Als een bedrijf trots is op een bepaalde functie in zijn nieuwe release, bijvoorbeeld EnergyMiser, zal het deze kapitaliseren, ook al kun je het niet afzonderlijk bestellen.

Hier zijn enkele typische richtlijnen voor hoofdletters:

Enkele of dubbele aanhalingstekens

Aanhalingstekens worden vaak ten onrechte gebruikt als benadrukkingstechnieken in technische teksten. Als technisch schrijver moet je aanhalingstekens beperken tot het traditionele gebruik, dat onder andere bestaat uit geciteerde spraak; cijfers, letters of woorden die als zodanig worden genoemd. Aanhalingstekens, net als hoofdletters, hebben de neiging een drukke, afleidende tekst te creëren en moeten daarom worden vermeden.

Een legitiem gebruik van dubbele aanhalingstekens is vreemde, eigenzinnige, niet-standaard gebruik van woorden (aangeduid als "schrik-aanhalingstekens" door Chicago Manual of Style). Bijvoorbeeld:

In een core dump "stort" de computer alle gegevens in één enkel bestand.

Goed ontworpen computertekst vermijdt aanhalingstekens vrij krachtig. Een van de belangrijkste redenen is dat sommige lezers ten onrechte kunnen aannemen dat ze de aanhalingstekens moeten opnemen in de commando's die ze invoeren.

In plaats van Gebruik de "verplaats" opdracht.
Schrijf Gebruik de verplaats opdracht.
In plaats van Voer "copy install installnow" in.
Schrijf Voer in kopieer installeren nu installeren

Opmerking: Hoewel sommige technische teksten goed gedefinieerde toepassingen voor enkele aanhalingstekens hebben, is er over het algemeen geen standaard gebruik voor enkele aanhalingstekens, behalve de traditionele regel voor citaten binnen citaten en de eigenaardig-gebruik regel. Wanneer je enkele aanhalingstekens ziet binnen technische tekst, is er meestal niet meer reden voor hun gebruik dan voor dubbele aanhalingstekens.

Alternatieve lettertypen

Een van de meest voorkomende stijlen met afwisselende lettertypen is het gebruik van Courier of een vergelijkbaar monospaced, typemachine-stijl lettertype in contrast met het standaard lettertype van de tekst (zoals Times New Roman of Helvetica). Je kunt dit effect op een webpagina creëren door een CSS-stijl te gebruiken zoals <span class="example_text">. Bijvoorbeeld, "type installeren om het programma te installeren."

Hier is een beoordeling van de veelvoorkomende toepassingen van alternatieve lettertypes:

Kleur

Kleur wordt gebruikt in technische teksten, maar het is duur en moeilijk te beheersen tijdens de publicatiefase.

Echter, kleur is gemakkelijk te gebruiken in online informatie. Het is gebruikelijk om hypertekstlinks te zien, bijvoorbeeld, met kleur. Online help gebruikt doorgaans groen, terwijl webpagina's doorgaans blauw gebruiken voor nieuwe links en paars voor links die de gebruiker al heeft onderzocht.

De neiging om kleur ondoordacht te gebruiken in online informatie is vergelijkbaar met de neiging om wild te gaan met vet, cursief, lettergroottes en alternatieve lettertypen in gedrukte informatie. Het gevoel moet iets zijn als: "Het is er, het is cool, dus laten we het gebruiken!"

Als je kleur wilt gebruiken, plan het dan zorgvuldig. Verwacht niet dat lezers zich herinneren dat rood één idee aangeeft, blauw een ander idee, en groen weer een ander idee. Blijf gewoon bij één kleur. Vermijd over het algemeen het gebruik van kleur voor langere teksten. In plaats van een hele waarschuwing rood te maken, maak je gewoon het label Waarschuwing rood en laat je de waarschuwende tekst in reguliere romeinse letters (zoals de reguliere lichaamstekst).

Beter nog, lees wat van de standaardliteratuur over kleur op het gebied van technische communicatie. Er zijn algemene ontwerpkwesties en internationale kwesties:

Combinaties van het voorgaande

Over het algemeen is het een slecht idee om accentuerings-technieken te combineren, bijvoorbeeld vetgedrukt en cursief. In niet-professionele technische teksten zie je zulke schreeuwerige combinaties als volledig hoofdletters vetgedrukt-cursief of volledig hoofdletters vetgedrukt-cursief met dubbele aanhalingstekens. Vermijd deze!

Een legitieme combinatie is om cursief te gebruiken met alternatieve lettertypen. Bijvoorbeeld, wanneer je de syntaxis van een commando toont, wil je dat de volledige tekst in Courier staat, maar je wilt ook dat de variabelen cursief zijn:

kopiëren OudeBestandsnaam NieuweBestandsnaam

Functionele Namen voor Karakterstijlen en Tags

Als je ooit in de uitgeefindustrie bent geweest, heb je misschien iets tegengekomen dat wordt genoemd semantische markup. Dit betekent secties van tekst te benoemen volgens de structurele rol die ze spelen in het document—bijvoorbeeld, koptekst. De lezer ziet deze namen niet, maar ze spelen een belangrijke rol in hoe het document is opgemaakt en hoe het hergebruikt kan worden.

Ditzelfde idee geldt voor woorden in zinnen binnen tekst. Bijvoorbeeld, in de HTML voor een webpagina kun je de <b>vetgedrukt woord</b> tags om een woord vet te maken. Maar vet geeft niet de functie van het woord of de zin aan. In plaats daarvan, opdracht zou of interface_label zou. Daarom zijn dingen in semantische opmaak met HTML CSS functioneler als ze er als volgt uitzien: <span class="command">vetgedrukt woord</span>.

Bestanden die HTML en CSS gebruiken, worden doorgaans geconverteerd naar andere media zoals PDF of zelfs van en naar XML. Gebruikmakend van functioneel genaamde markeerstijlen, zoals hierboven beschreven, kunnen het conversieproces aanzienlijk vergemakkelijken.

Verdere Verkenningen

Zodra je het bovenstaande hebt gelezen, is een goede volgende stap om technische publicaties te verkennen om te zien welke highlight-schema's ze gebruiken. Let op de manier waarop dingen zoals vet, cursief, hoofdletters, alternatieve lettertypen en dergelijke effecten worden gebruikt. Je zult waarschijnlijk heel andere toepassingen zien dan wat je hier hebt gelezen. Terwijl je verkent, denk na over de logica van de benadrukkingstechnieken die je ziet; probeer de regels te formuleren die de schrijvers lijken te gebruiken; let op inconsistenties in de benadrukking; en denk kritisch na over het gebruik dat je ziet—is het logisch? Te veel? "Te weinig?"

Nadat je zoiets hebt verkend, is de volgende logische stap om het hoofdstuk te lezen over stijlrichtlijnen, als je dat nog niet hebt gedaan. Markeeringsschema's moeten worden gedocumenteerd in stijlhandleidingen, zodat je ze niet vergeet en zodat je teamleden voor documentatie ernaar kunnen verwijzen.

Markeerschema

Als alle besproken opties en alternatieven je overweldigen, overweeg dan het gebruik van het volgende benadrukking-schema. Het is gebaseerd op de markeringen die je in veel UNIX-, Windows- en Linux-documenten zult vinden.

Namen van velden, mappen, dialogen (vakken), menu's (elk interface-object dat gebruikers doen niet klik op) Hoofdletterstijl op het scherm; reguliere romeinse
Namen van iconen Capsstijl op het scherm; vetgedrukt
Knoppen (of functioneel equivalent als niet zo gelabeld) Hoofdletterstijl op het scherm; vetgedrukt
Menu selecties, selecteerbare opties Hoofdletterstijl op het scherm; vetgedrukt
Opdrachten precies ingevoerd zonder parameters of vlaggen Vetgedrukt
Ingevoerde of weergegeven tekst Courier New (indien nodig, 1 punt kleiner dan het hoofdlettertype)
Variabelen Cursief; reguliere romeinse
Programmeren code Courier New; reguliere romeinse; indien nodig, 1-punt kleiner dan het hoofdlettertype
Labels op hardware Courier New; vetgedrukt; indien nodig, 1 punt grootte kleiner dan het hoofdlettertype

  • Notities:

    1. Regelmatige roman verwijst naar welk lettertype en lettergrootte worden gebruikt voor de hoofdtekst.
    2. Hoewel deze suggesties "hoofdletterstijl op het scherm" aanbevelen, hebben ontwikkelaars soms de ongelukkige neiging om alleen hoofdletters te gebruiken. Omdat een stijl met alleen hoofdletters de leesbaarheid vermindert, gebruik toch beginletters (titelcase).
    3. Als je gebruikers laat zien hoe ze een commando moeten invoeren, inclusief voorbeeldtekst, maak dan het commando in de voorbeeldtekst niet vetgedrukt:
    4. Gebruik de mv commando om de naam van de locatie van een bestand te veranderen, bijvoorbeeld:
      mv ditbestand.txt datbestand.txt.

    5. Als je gebruikers laat zien hoe ze een opdracht moeten invoeren, inclusief voorbeeldtekst, en variabelen in de voorbeeldtekst opnemen, gebruik dan cursief voor de variabelen.
    6. Gebruik de mv commando om de naam van de locatie van een bestand te wijzigen:
      mv mijn_bestand.txt je_bestand.txt.

    7. Als je eenvoudigweg verwijst naar de naam van een scherm of menu dat niet wordt aangeklikt of geen enkele gebeurtenis initieert, gebruik dan hoofdletters voor het scherm en gewone romeinse letters.
    8. Sommige stijlen benadrukken de actie die gebruikers moeten ondernemen (bijvoorbeeld, pers, Inloggen, verwijderen). Dat is zeker een optie, maar voor mij is het te veel benadrukken.

    Gebruikshandleidingen plaatsen vaak een overzicht van de betekenissen van gemarkeerde lettertypen, kleuren en typografie in de inleiding:

    Highlighting chart


    Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk op prijs stellen: uw reactie.