Ressourcer til teknisk skrivning

Denne side indeholder en oversigt over yderligere ressourcer til teknisk skrivning.

Redaktionelle stilvejledninger

En redaktionel stilvejledning definerer en redaktionel gruppes retningslinjer for kommunikation. Hvilken af følgende regler bør din organisation f.eks. vedtage for overskrifter?

• Sæt overskrifter i sætningsbetegnelse (kun det første ord i hver overskrift skrives med stort)
• Sæt overskrifter i titelbetegnelse (de fleste af ordene i hver overskrift skrives med stort)

Spild ikke tid og energi på at diskutere denne slags spørgsmål.Bed i stedet bare din organisation om at vedtage en bestemt redaktionel stilguide.En redaktionel stilguide giver et sæt svar på spørgsmål om valg af skriftlige valg. Det er ligegyldigt, at en redaktionel stilvejledning anbefaler sætningshøjde, mens en anden foretrækker titelhøjde. Det er kun vigtigt, at din organisation vedtager en enkelt redaktionel stilvejledning.

Ah, men hvilken redaktionel stilvejledning?Du er måske allerede bekendt med redaktionelle stilvejledninger til generelle formål (såsom Chicago Manual of Style eller University of Oxford StyleGuide).Dit tekniske team bør dog bruge en redaktionel stilvejledning, der er specialiseret i teknisk skrivning. Vi anbefaler at vælge en af følgende:

• Google Developer Documentation Style Guide indeholder redaktionelle retningslinjer for alle, der skriver udviklerdokumentation til Google-relaterede projekter.
• Microsoft Writing Style Guide indeholder retningslinjer for alle, der skriver teknisk dokumentation.

Du skal ikke skrive din egen redaktionelle stilguide. At oprette og vedligeholde en “hus”-redaktionel stilguide kræver enorme ressourcer og giver anledning til enormekonflikter. Når det er sagt, er der nogle organisationer, der præger ny terminologi, som ikke findes i en eksisterende redaktionel stilguide. Når det sker, kan organisationen gøre et af følgende:

• Bede dem, der vedligeholder en redaktionel stilguide, om at tilføje de nye udtryk.
• Skab og vedligehold din egen brugsvejledning eller dit eget stilark, der kodificerer stavemåder og ordbrug for din organisations specialiserede ordforråd.

Open-source dokumentationsmuligheder