tekniskt skrivande är praxis att bearbeta dokument och bilder, verbal information och demonstrationer till instruktionsutbildningsmaterial. Syftet med tekniskt skrivande är att tillhandahålla material som förklarar en process eller göra ett komplext koncept lättare att förstå för en viss publik. Genom effektivt och effektivt tekniskt skrivande kommer författaren att kunna förklara och hjälpa läsaren att förstå information och utföra specifika uppgifter. Det finns fem universella etiska principer för tekniskt skrivande. Principerna är kvalitetsinnehåll, publik och syfte, tillgänglighet, grammatik och skrivstil.
kvalitetsinnehåll
kvalitetsinnehåll är subjektivt. MATC: s definition av högkvalitativt innehåll är en produkt som uppfyller kundens standarder eller går utöver projektets ursprungliga omfattning. För att producera ett högkvalitativt projekt måste du skriva med den avsedda publiken i åtanke. Författaren måste undersöka ytterligare kunskaper som behövs innan dokumentet eller materialet är klart. Författaren behöver veta vilket format eller plattform som ska användas för att representera informationen. Författaren måste bestämma specifik information som sträcker sig från att veta vad tidsfristerna är att veta varför informationen måste skrivas.
publik och syfte
författaren behöver förstå både syfte och publik för att skapa en enastående teknisk Bit. Den tekniska skrivpubliken varierar beroende på branschen och den specifika kunden. Till exempel skulle publiken i en varvrapport vara produkttillverkningen som anställde oss som författare. Publiken för en eLearning utbildningsmodul kan vara en bank eller inteckning leverantör som behöver efterlevnad utbildning. Författaren måste veta hur mycket läsarna kommer att veta och vilka ansvar författaren är skyldig att uppfylla när det gäller att kommunicera med läsarna.
tillgänglighet
det är viktigt för publiken att kunna få tillgång till den information som författaren skapade med lätthet. Tillgänglighet inkluderar allt som finns i ett dokument, till exempel sidhuvud och sidfot, eller på iLearn-moduler för datorer, vilket förbättrar tillgänglighetsformateringen för att bli mer universell och tydligare. Den tekniska författaren måste ta reda på den bästa metoden för att hjälpa läsarna att navigera i dokumentationen med noteringar från en bibliografi till en sidnummer till en innehållsförteckning. Författaren kan till och med lägga till bilder, som diagram och figurer, för att förklara informationen ytterligare.
grammatik
att skriva klart, koncist och enkelt med en korrekt användning av grammatik är avgörande för att skriva något tekniskt stycke. Författaren måste också korrekturläsa och redigera alla tekniska bitar som skrivs för att korrigera eventuella fel eller inkonsekvenser med grammatik, stil och layout. En teknisk författare ska alltid skriva i nuvarande tid om inte kunden anger deras preferens annars. Läsaren av det tekniska stycket bör göra exakt vad du ger instruktioner för. Författaren ska alltid skriva i enkla meningar som innehåller könsneutrala substantiv. Enkla meningar hjälper läsarna att tydligt och effektivt förstå de uppgifter de måste åta sig för att slutföra sina mål.
skrivstil
skrivstilen skiljer sig åt för varje tekniskt stycke eftersom det starkt beror på vem publiken är och scenariot som det tekniska stycket skrivs för. Tonen i ett tekniskt skrivstycke är viktigt eftersom det hjälper läsaren att förstå vilken typ av ton som krävs för att slutföra uppgiften. Ordval är också en viktig del av stilen för att hjälpa till att tillgodose publikens behov eftersom den ansluter till vem din publik är. När du refererar till delar av information eller webbplatser är det viktigt att tillhandahålla tydliga och synliga sätt att komma åt informationen med hjälp av verktyg, till exempel siffror och tabeller.
andra tekniska skrivtips
gör Extra forskning och lär dig mer
att veta det minsta minimum kanske inte får det bästa tekniska stycket för att hjälpa publiken att förstå informationen. Det kan finnas mycket terminologi som både författaren och läsaren kanske inte förstår. Som tumregel, Om du som läsare inte förstår ett begrepp eller en term, definiera det. För mycket information kan alltid skäras ner i senare recensioner. Denna information bör undersökas för att förstå hur det fungerar med vad författaren skriver som helhet. Undersök en liten far och ta reda på vilken annan information som kan användas för att förbättra den tekniska delen som skrivs.
bli publiken och underskatta publiken
sätt dig själv i publikens skor. Kan du tydligt förstå och följa instruktionerna eller informationen som du har skrivit för publiken? Om ja, kan du ge mer information om du tror att det behöver lite mer hjälp. Om inte, måste du hitta de delar som inte är tydliga och hitta ett sätt att tillhandahålla informationen korrekt. Ett stort problem som tekniska författare ofta har är att de överskattar kunskapen om sin publik. Publiken kan vara flera personer på olika kunskapsnivåer. Det är helt acceptabelt att kortfattat ge information som kan antas eller redan anges som en uppdatering för publiken.
be om ett andra och tredje yttrande och Peer Review
tekniska författare är resursfulla. Den största resursen du har är dina ämnesexperter. Se till att fråga dina små och medelstora företag om de ser några kunskapsluckor eller fel. Författare kontrollerar med sina kunder för att se om det finns några kunskapsluckor eller fel som författaren kan förbise. Att ha en Handledare eller kollega titta över och ge ett yttrande kan också bidra till att förbättra en teknisk Bit. Peer review är när en grupp människor träffas för att läsa, kommentera och rekommendera förbättringar av varandras arbete. Fler blinda fläckar blir avslöjade när fler människor granskar ett dokument, vilket garanterar korrekt och kortfattad information.
tekniska författare lär sig ny information för varje projekt de arbetar med. Författarna får en bättre förståelse för vad kunderna behöver eftersom de börjar under kunskapsnivån hos sina läsare före all forskning och diskussioner med ämnesexperterna. Detta blir en stor tillgång för företag eftersom mindre antaganden öppnar för effektivare utbildning. Kombinationen av författarna som lär sig materialet och dessa etiska principer för tekniska skrivstandarder leder till mer självsäkra och effektiva anställda.