Tekniskt skrivande förmedlar teknisk information om en färdighet eller produkt till läsarna. Det används ofta inom tekniska och yrkesmässiga områden. Som teknisk skribent skriver du ofta dokument som användarguider, dokumentation för applikationsprogrammeringsgränssnitt (API) och reparations- och produktmanualer.
Precis som andra skrivnischer har tekniskt skrivande nischspecifika riktlinjer. Att följa dessa riktlinjer hjälper dig att skriva välstrukturerade dokument och optimera hur läsarna förstår ditt arbete. Här är några regler att följa för att bli en bra teknisk skribent.
1. Definiera din målgrupp
Publikanalys är en oumbärlig faktor i ett bra tekniskt dokument. Att känna till din publik hjälper dig att avgöra vilken typ av information du ska skriva om, hur du ska strukturera den och det tekniska i ditt språk. Det finns fyra stora målgrupper för tekniskt skrivande: chefer, experter, tekniker och icke-specialister.
Chefer är individer som finansierar produkten och fattar de politiska, administrativa och ekonomiska beslut som styr den. Tekniker är människorna som bygger, driver och reparerar dessa produkter. Experter designar, testar och vet allt om produkten, medan icke-specialister är slutanvändarna av produkterna. Du måste överväga din publik för att bestämma den bästa tonen och skrivstilen att använda.
2. Identifiera din publiks behov
Förutom att känna till och definiera din publik är det avgörande att du förstår deras mål, intressen och behov. Att slutföra din målgruppsanalys är nyckeln i dokumentförberedelse, eftersom du är mindre benägen att skriva utan hicka och känner din publiks behov väl.
För att genomföra en väl avrundad publikanalys måste du ta hänsyn till din publiks bakgrund, befintliga kunskaper om produkten, erfarenhet, behov, intressen, demografiska egenskaper, kultur och kommunikationspreferenser, och mål. Denna information kommer att hjälpa dig att presentera dina idéer mest effektivt och effektivt.
3. Lär dig gränsen för din publiks kunskap
Som en publikanalysteknik kan du använda undersökningar och frågeformulär för att veta gränsen för din publiks kunskap. Du kan också hämta populära åsikter och stereotyper, personlig erfarenhet, brainstorming och feedback från publiken från marknadsavdelningen.
Om du använder de ovan listade verktygen på rätt sätt kommer du att veta hur mycket din målgrupp förstår informationen du tänker förmedla. Denna information kommer i hög grad att avgöra ditt dokuments struktur, gränser och omfattning, vilket ger dig en känsla av riktning.
4. Håll ditt språk enkelt
Tekniskt skrivande är tänkt att presentera ett alltför komplicerat ämne. Den gör detta genom att använda en enkel skrivstilsguide. Du bör se till att den genomsnittliga läsaren lätt kan förstå ditt skrivande.
Du måste dock notera att förståelse för din publik också är nyckeln till den språkstil du väljer. Till exempel professionell jargong i ett dokument om applikationsprogrammeringsgränssnitt (API) kan vara lämpligt för tekniker men inte slutanvändare. Följaktligen måste du använda ett lättförståeligt språk för att hjälpa publikens förståelse. Du kanske också vill lära dig hur man använder ett verktyg som Microsoft Editor att kontrollera ditt arbete och se till att skrivningen är korrekt.
5. Använd konturer
Konturer ger dina läsare en uppfattning om vad de kan förvänta sig i dokumentet. Ett dokument utan kontur överväldigar läsarna, eftersom det tvingar dem att läsa hela texten när de bara är intresserade av att skaffa sig specifik kunskap.
Som en teknisk skribent ger det dig också en känsla av riktning när du skriver en beskrivning av ditt dokument. Det håller dig på rätt spår och säkerställer att du inte missar eller underskattar relevanta poäng. Dessutom förbättrar det strukturen i ditt dokument och fungerar som feedback på vad du tänker täcka.
6. Använd grafik där det behövs
De flesta läsares uppmärksamhet dras naturligtvis till grafik jämfört med text. I tekniska dokument kan lämplig grafik förbättra läsarnas förståelse av texten genom att presentera information tydligt och eftertryckligt.
Men som teknisk skribent bör du vara försiktig så att du inte använder grafik för att dekorera dokument. Tabeller, grafer, diagram, fotografier och illustrationer är vanliga grafik, och de kan förbättra dokumentets övergripande struktur och tilltala läsarna. Som sagt, om du är ny på Google Dokument, här är hur man skapar och redigerar tabeller i Google Dokument.
7. Engagera dina läsare
Även om du kanske försöker förmedla teknisk information till dina läsare, är det viktigt att du också engagerar dem. Varje tekniskt dokument är läsarcentrerat och bör skrivas efter läsarens smak och inte författarens. Din läsares intellektuella nyfikenhet måste tillfredsställas för att ditt dokument ska vara användbart.
Du kan aktivt engagera din läsare genom att skriva för att uttrycka, inte imponera, och komma rakt på sak. Undvik förkortningar och jargong, använd mycket vitt utrymme för att förbättra den visuella presentationen och använd rubriker för att vägleda din läsare.
8. Referera inte till tidskänslig information
Att undvika hänvisningar till tidskänslig information, särskilt de från en jämförbar period, är alltid att föredra. Det är säkrare och klokare att använda analys som har stått emot tidens tand, vilket gör den vintergrön och alltid lämpad för dem som kommer att läsa ditt dokument i framtiden.
Du måste också notera att att bifoga specifika årtal, som "2019", för att betona din poäng kan minska användbarheten av ditt dokument över tid, utom i specifika fall. Du kan förhindra detta genom att använda en bredare tidsram som "Under de senaste sju åren", vilket ger ditt arbete en nivå av trovärdighet.
9. Använd relevanta exempel
När du skriver ett tekniskt dokument, använd live-instanser för att betona dina poäng. Eftersom din publik läser ditt skrivande för att skaffa sig en färdighet, lösa ett problem eller lära dig några riktlinjer, måste du ge dem praktiska och relaterbara exempel.
Dessa exempel förbättrar ditt arbetes läsbarhet och kommunicerar komplex information till din läsare, vilket ger sammanhang åt produkter och processer. På så sätt är det mer sannolikt att de använder produkterna avsiktligt och säkert.
10. Få en recension från tredje part innan du publicerar
Ett tekniskt dokument ska alltid gå igenom en samarbetsprocess som involverar skribenten och granskaren. En granskning från tredje part hjälper till att skapa ett publikfokuserat, felfritt och effektfullt dokument.
Som dokumentets ursprungliga författare kan du ha skrivit många utkast innan du skapade det slutliga dokumentet. Men oavsett hur bra ditt dokument ser ut, lita inte bara på ditt förstånd.
Bli en professionell teknisk skribent idag
Att förstå de grundläggande reglerna för tekniskt skrivande kommer att göra dig mer skicklig och mycket eftertraktad. Många organisationer vet hur viktigt det är att deras produkter eller tjänster marknadsförs väl till slutanvändare, och att hjälpa dem att uppnå detta är ditt mål som teknisk skribent.