E2a

Hur avmystifiera teknisk dokumentation för en genomsnittlig användare

När kreativa författare ställs inför ett jobb som kräver tekniska skribenter, vissa reagerar omedelbart i absolut terror. Tekniskt skrivande är verkligen långt ifrån kreativt skrivande och kräver en avvikelse från komfortzon och sagoland som erbjuds av denna disciplin. Men vad de kanske saknas är en enkel sanning: tekniska eller kreativa, förblir principen densamma - Skriva förstås. Så även om ämnet gräver i vetenskap, teknik, matematik, medicin eller lagen kan du skriva med lätthet så länge du vet hur man skriver den med klart och enkelt språk utan dumbing innehållet nedåt. Ganska bedrift, ja, men omöjligt, nej.

Så här avmystifiera teknisk dokumentation för en genomsnittlig användare:

  1. Skriv för din målgrupp. Beviljas att skrivandet är ett uttryck och en ofta narcissistiska upplevelse måste du som professionell författare avsätta ditt ego att behaga det som betyder mest, din # 1 kund: publiken. Forskning är kritisk så ta reda på vad de vill och behöver tillsammans med sina demografi så att du kan justera tonen och språket därefter. Genom att göra så kommer du att kunna uppnå vad någon författare vill och det är ... acceptans.
  2. Var kortfattad och direkt. Det är så lätt att ryckas när du skriver så passionerat om ett ämne du vet. Det är bra om du skriver ett reportage, en täckmantel, en roman eller en uppsats, men när det kommer till tekniska skribenter, korta och direkta är definitivt att föredra.
  3. Vara animerade. Använd en aktiv röst och behålla texten underhållande med starka verb när det är möjligt. Till exempel läser aktiv röst "Jennifer använde en nätsladden okänsliga en magnet," i motsats till den passiva röst, "Magneten var okänsliggöras med en strömkabel som används av Jennifer."
  4. Ge tydliga anvisningar till läsaren. Du kan göra detta genom att använda 2: a personen "Du", då följer upp det med nuvarande spända riktningar som i: ". Du tar de röda och blå trådar och mesh dessa tillsammans för el att flöda"
  5. Anta en organiserad flöde. Du kan välja numrerade listor eller punktlistor för att presentera dina rutiner, processer, fakta, teorier och argument. Helst bör numrerade listor eller punktlistor går aldrig längre än sju punkter.
  6. Korrekturläsa ditt arbete. Vill du veta en av de mest effektiva korrekturläsning tekniker bortsett från ett datorprogram gör det för dig? Läs din text bakåt. Prova det.
  7. Låt andra människor läser ditt arbete. Fokusera på att få ett yttrande från en ämnesexpert (SME) som kan berätta vad som saknas, vad du behöver förbättra och hur att göra innehållet extremt läsvänliga.
  8. Håll det enkelt. Anpassa en konservativ attityd när det gäller att använda hög falluting ord när du skriver. Såvida du skriver för kungligheter, softa på snobbig innehållet så att publiken kan relatera till vad du skriver.

Om du är en författare som är livrädd med något tekniskt

Hur avmystifiera teknisk dokumentation för en genomsnittlig användare. Skriv för din målgrupp.
Hur avmystifiera teknisk dokumentation för en genomsnittlig användare. Skriv för din målgrupp.

Om du är en författare som är livrädd med något tekniskt, kanske du vill få dina fötter är våta innan låta hot kör du helt borta. I slutändan kanske du gillar tekniska skribenter. Du kommer inte veta förrän du försöker, eller hur?