E2a

Sådan gør du tekniske skriftligt

Evnen til at skrive historier ikke automatisk gøre dig til en god teknisk forfatter

Teknisk skrivning har flere definitioner. Grundlæggende er der to typer - skriftlig tekniske manualer og instruktion brochurer, såsom software dokumentation eller produktspecifikationer, og skrive kronikker, case studies eller marketingmateriale om tekniske emner, der er beregnet til et teknisk læserskare, som regel i en bestemt branche . Selv om jeg vil tage fat både i denne artikel, vil sidstnævnte være hovedemnet.

Hvis du vil skrive tekniske manualer og dokumentation, skal forfatteren typisk være meget fortrolig med emnet. Med andre ord, er du ikke tilbøjelige til at tage et nyt job som en tech skribent for Company X en dag, og derefter sidde ned den næste dag og begynde at skrive brugsanvisninger for deres nyeste produkter. I stedet skal du få en grundlæggende forståelse af teknologi, applikationer og berørte produkter. Dette er typisk tilfældet. Men som du kan se senere, kan en god forfatter tilpasse sig til enhver form for skrift, forudsat at der er en tilgængelig informationskilde. For dokumentation skriftligt, for eksempel med en tilgængelig kilde til viden vil gøre opgaven mindre skræmmende, især hvis kilden har et væld af tålmodighed og forstår din situation.

Skrivning kronikker, såsom hvordan en teknologi er tilpasset til en særlig anvendelse, kræver mindre personlig viden. Dog mindst en god kilde til information er stadig et krav (to eller flere er endnu bedre). I denne type skriftlig, interviews og transskriberet, før du begynder at skrive det første udkast. Nedenfor er nogle skridt og henvisninger til at skrive en god teknisk funktion, hvidt papir eller casestudie på det tekniske emne.

  1. Vælg en branche. En god technical writer vil finde mere succes i at vælge en bestemt industri, såsom telekommunikation, medicinsk, biler, computere osv., som skal fokusere på. Selv om en god tech forfatter normalt kan skrive om et emne, er det helt sikkert hjælper at få så meget viden som muligt ved at holde en industriens teknologier. Næsten enhver succesfuld tech forfatter er forbundet med en industri. Det vil også med tiden etablere forfatteren som en "ekspert" slags inden for en branche - at bringe flere opgaveskrivning inden for denne industri segment.
  2. Find ud af, hvad der er hot og hvad er ikke? Valg af dit emne for en artikel er vigtig. Selvfølgelig, hvis du ghostwriting for en klient, som jeg gør, er dine emner typisk gives til dig. Ellers find ud af hvad er i øjeblikket den varmt emne i din branche. Hvis du får brug for et sted at offentliggøre artiklen, er det godt at gennemse den redaktionelle kalendere på de relevante fagtidsskrifter. Mange har online-muligheder samt print. Hvis du kan matche et varmt emne til en kommende udgave emne på det redaktionelle kalender, der er en bedre end gennemsnittet chance for at få din artikel valgt.
  3. Det næste skridt er at kontakte publikationen og forsyne dem med et abstrakt - omkring 50 til 100 ord der beskriver indholdet af din foreslåede artikel. Det er tilrådeligt at sende en abstrakt ad gangen til en udgivelse kilde i modsætning til "shotgunning" det abstrakte til alle på én gang. De fleste udgivere ønsker eksklusivitet, når det kommer til at udgive din artikel.
  4. Opsætning og gennemføre interviews. Efter at have besluttet på et emne og finde en "hjem" for artiklen, skal du oprette dine samtaler med de pågældende eksperter. For en hvidbog eller case study, vil interviewet sandsynligvis være med en eller to interne kilder på en bestemt virksomhed. For et casestudie, kan dette være en person fra virksomheden og en anden fra kunden med henblik på at gøre et "problem / løsning" format om emnet.

    Gode ​​interviews kan nemt udføres over telefonen, hvis mange miles adskille dig fra kilderne. En anden metode, dog ikke anbefales, er at e-maile spørgsmål til de kilder og få dem skrive deres svar på en tilbagevenden e-mail. Jeg vil anbefale face-to-face, telefon og e-mail - i den rækkefølge.

    Sådan gør du tekniske skriftligt. Find ud af, hvad der er hot og hvad er ikke?
    Sådan gør du tekniske skriftligt. Find ud af, hvad der er hot og hvad er ikke?

    For telefoninterviews, er det bedst at optage hele interviewet, hvis det er muligt. Telefon registreringsanordninger kan købes på de fleste computer / telefon butikker for omkring 15€. Disse er forbundet mellem en telefon og registreringsapparat. Husk, nogle stater tillader ikke disse elementer, så tjek det ud for din tilstand. Også, bør du optage dig selv i starten af ​​interviewet fortæller den kilde, du taping interview til transskribere senere.

    Interviewet for en teknisk papir er ulig en nyhedshistorie interview. For hvidbøger eller meget tekniske artikler, kan du har meget lidt viden om emnet. I så fald, lad emnet ekspert vide, at du stoler på ham eller hende til at give alle de oplysninger, de ønsker i avisen. Dybest set, hvis de ikke siger det, vil det ikke være i papiret! Nogle gange hjælper det at have en kugle skitse i stedet forud for interviewet opkald.

  5. Transskribere interviewet. Dette er simpelthen lytter til optagelserne og skrive det ind i en fil. Men det er også en god måde at lære gennem gentagelse. Selvom emnet kan være uklar ved bedst for dig, lytter en anden eller tredje gang til interviewet kan bidrage til at gøre tingene på en lidt bedre. De ord og idéer synes at begynde at give mere mening, den anden gang omkring. Også i tiden og med praksis, vil du begynde at skrive, som du omskriver. Det betyder i stedet for at skrive interviewet ord for ord, du begynder at tage ideer og omformulere dem til din egen skrivestil. Vær forsigtig, at du ikke ændrer betydningen eller tanke! Men du kan faktisk begynde at stykke artiklen sammen under transkription processen.
  6. Skriv artiklen. Tage udskrifter og sætte dem ind i faste, læsbare stykker er det næste skridt. De fleste tekniske artikler Brug korte afsnit af to eller tre sætninger hver, sammen med hyppige sub-hoveder til at bryde op tekst. Som med din overskrift, skal du bruge fantasifulde underoverskrifter som fanger læserens opmærksomhed.

    Et dæk kan også tilsættes efter overskriften at give flere oplysninger om emnet for artiklen. Det er her, dine skrivefærdigheder tage fat. De første par stykker eller introduktion bør sætte scenen for resten af ​​artiklen. Hvis det interesserer læseren, vil han eller hun læste videre. Hvis ikke, vil de aldrig komme til resten af ​​artiklen.

    Emnet kan derefter opdeles i underemner inden for artiklen kroppen. Konklusionen, som med enhver skrevet artiklen, gentage og bør indkapsle indledningen.

  7. Gennemgå udkastet og indsende artiklen. Læs artiklen igennem efter stavekontrol. Check for glidende overgange fra den ene tanke til den anden. Har en anden person læse igennem og komme med forslag eller lade dig vide, hvad forvirrer dem.

    Evnen til at skrive historier ikke automatisk gøre dig til en god teknisk forfatter. Det næste skridt er at kontakte publikationen og forsyne dem med et abstrakt.
    Evnen til at skrive historier ikke automatisk gøre dig til en god teknisk forfatter. Det næste skridt er at kontakte publikationen og forsyne dem med et abstrakt.

    Efter det første udkast er færdig, skal du sende det til dine interview kilder til at kigge forbi. De vil typisk have ændringer, tilføjelser, udeladelser, etc., og bør velkommen til at "pynte" på noget. Bed dem om at sende deres ændringer tilbage til dig og indarbejde deres forslag om at udfylde et endeligt udkast.

    Det sidste trin er at sende den udfyldte artiklen til udgiveren. Gennem hele processen være meget opmærksom på eventuelle tidsfrister, ordantal krav eller andre formatering kriterier, der fremgår af udgiveren.

Skrivning tekniske artikler er udfordrende, men antallet af gode tekniske forfattere i enhver industri er få. Dette skaber mulighed for dig. Når du oprette dig selv som en "gå til" technical writer i en bestemt branche segment, du er på din vej til succes på området. Den nederste linje er dette: en forfatter er en forfatter, uanset typen af ​​skriftligt eller emnet. Enhver, der kan skrive en nyhedsartikel eller en pressemeddelelse eller en god novelle kan også skrive en teknisk stykke. Husk, vel vidende emnet, selvom det primære afskrækkende bliver en tech forfatter, ikke er nær så vigtigt som god all-around skrive færdigheder og en sikker attitude.

Robert Pease er grundlægger, præsident og senior teknisk skribent på Write-Way Independent Editorial Services LLC ( www.write-way.net ), der ligger i Barnstead, NH. Han øjeblikket skriver for mere end 30 tekniske virksomheder, primært i telekommunikationsindustrien. Hans forfatterskab spænder over mere end 25 år.