Technical writing resources

Deze pagina geeft een overzicht van aanvullende technical writing resources.

Editorial style guides

Een editorial style guide definieert de richtlijnen voor communicatie van een redactionele groep. Welke van de volgende regels zou uw organisatie bijvoorbeeld moeten hanteren voor koppen?

• Zet koppen in hoofdletters (alleen het eerste woord van elke kop een hoofdletter)
• Zet koppen in hoofdletters (de meeste woorden in elke kop een hoofdletter)

Verlies geen tijd en energie aan geruzie over dit soort vragen.Vraag uw organisatie in plaats daarvan gewoon om een bepaalde redactionele stijlgids aan te nemen. Een redactionele stijlgids geeft een reeks antwoorden op vragen over schrijfkeuzes. Het maakt niet uit dat de ene redactiestijlgids de voorkeur geeft aan hoofdletters en de andere aan kleine letters. Het maakt alleen uit dat uw organisatie één enkele redactionele stijlgids hanteert.

Ah, maar welke redactionele stijlgids? U bent wellicht al bekend met redactionele stijlgidsen voor algemene doeleinden (zoals de Chicago Manual ofStyle of deUniversity of Oxford StyleGuide).Uw engineeringteam zou echter een redactionele stijlgids moeten gebruiken die is gespecialiseerd in technisch schrijven. Wij raden u aan een van de volgende te kiezen:

• De Google-stijlgids voor ontwikkelaarsdocumentatie biedt redactionele richtlijnen voor iedereen die ontwikkelaarsdocumentatie schrijft voor Google-gerelateerde projecten.
• De Microsoft-stijlgids voor schrijven biedt richtlijnen voor iedereen die technische documentatie schrijft.

Schrijf niet uw eigen redactionele stijlgids. Het maken en onderhouden van een “huis”-redactionele stijlgids vergt enorme middelen en veroorzaakt enorme conflicten. Toch komt het voor dat organisaties nieuwe terminologie gebruiken die niet in een bestaande redactionele schrijfwijzer voorkomt. Wanneer dat gebeurt, kan de organisatie een van de volgende dingen doen:

• Vraag de beheerders van een redactionele schrijfwijzer om de nieuwe termen toe te voegen.
• Creëer en onderhoud uw eigen gebruikshandleiding of stijlblad dat spelling en woordgebruik voor de gespecialiseerde woordenschat van uw organisatie codificeert.

Open-source documentatiemogelijkheden