Resurser för teknisk skrivning

Denna sida sammanfattar ytterligare resurser för teknisk skrivning.

Redaktionella stilguider

En redaktionell stilguide definierar en redaktionsgrupps riktlinjer för kommunikation. Vilken av följande regler bör din organisation till exempel anta för rubriker?

• Sätt rubrikerna i sentence case (skriv endast det första ordet i varje rubrik med versaler)
• Sätt rubrikerna i title case (skriv de flesta av orden i varje rubrik med versaler)

Spill inte tid och energi på att bråka om den här typen av frågor.Be i stället din organisation att anta en viss redaktionell stilguide.En redaktionell stilguide ger en uppsättning svar på frågor om skrivtekniska val. Det spelar ingen roll om en redaktionell stilguide förespråkar satsbokstäver och en annan föredrar titelbokstäver. Det spelar bara roll att din organisation antar en enda redaktionell stilguide.

Ah, men vilken redaktionell stilguide?Du kanske redan är bekant med redaktionella stilguider för allmänna ändamål (t.ex. Chicago Manual of Style eller University of Oxford StyleGuide).Ditt ingenjörsteam bör dock använda en redaktionell stilguide som specialiserar sig på teknisk skrivning. Vi rekommenderar att du väljer någon av följande:

• The Google developer documentation style guide ger redaktionella riktlinjer för alla som skriver utvecklardokumentation för Google-relaterade projekt.
• The Microsoft Writing Style Guide ger riktlinjer för alla som skriver teknisk dokumentation.

Skriv inte din egen redaktionella stilguide. Att skapa och underhålla en egen redaktionell stilguide kräver enorma resurser och orsakar enorma konflikter. Vissa organisationer använder sig dock av ny terminologi som inte finns i en befintlig redaktionell stilguide. När det händer kan organisationen göra något av följande:

• Behöva att de som upprätthåller en redaktionell stilguide lägger till de nya termerna.
• Skapa och underhålla en egen användningsguide eller ett stilblad som kodifierar stavningar och ordanvändning för organisationens specialiserade vokabulär.

Möjligheter till dokumentation med öppen källkod