grundläggande principer för tekniskt skrivande

då och då måste vi se över de grundläggande principerna för tekniskt skrivande. Sedan vi startade 1997 har de grundläggande principerna för tekniskt skrivande förblivit desamma, även när kommunikationssätten förändras.

syfte och publik

innan ett nytt skrivprojekt påbörjas måste en teknisk författare analysera syftet med dokumentet och identifiera dess avsedda publik. Författaren måste fråga:

• vem ska läsa dokumentationen?
• Vad är deras fördomar?
• vilket ansvar har jag när jag kommunicerar information till publiken?

stilguide

tekniska författare använder ofta en företags stilguide, om tillgänglig, för att säkerställa att deras dokumentation har ett strukturerat mönster. En stilguide (som AP Stylebook) ger riktlinjer för hur ett dokument ser ut, vilket språk det använder och hur ideer ordnas. Denna organisation ger kontinuitet till ett dokument eller en serie dokument, så publiken kan enkelt förstå informationen. Till exempel kan en teknisk författare dokumentera en process kronologiskt, som dikteras i stilguiden. Utan den strukturen skulle läsaren vara förvirrad och oförmögen att följa processen. Stilguider gör skrivandet mer konsekvent och läsbart.

skrivstil

tekniska författare ändrar sin skrivstil beroende på publiken och situationen de skriver om. Om de skriver teknisk dokumentation, bör stilen vara formell, saknar känslan du får med kreativt skrivande. Om de skriver ett mail till en av de ledande befattningshavarna som är involverade i projektet, skulle deras stil vara mer konversation.

åtkomst till informationen

tillgänglighet är hur lätt informationen i ett dokument kan erhållas av den avsedda publiken. Ett tekniskt dokument innehåller element som en innehållsförteckning, sidhuvud, sidfot och sidnummer för att hjälpa läsarna att navigera i dokumentet och hitta den information de behöver. Ett tekniskt dokument följer också en specifik struktur av rubriker och underrubriker för att dela upp informationen i relevanta avsnitt som läsaren lätt kan komma åt.

dessa är bara några av de aspekter vi behandlar som tekniska författare. Om du vill förbättra dina egna tekniska skrivfärdigheter, överväga vår tekniska skrivverkstad. Det kan anpassas för att möta behoven hos 1 person eller 20 personer!

om du inte vill skriva dokumentet själv och behöver hjälp från en erfaren teknisk författare, kolla in vår servicesida.

vi är här för att hjälpa. Kontakta oss idag!