Teknisk skriving - Technical writing

Teknisk skriving er å skrive eller utarbeide teknisk kommunikasjon som brukes på tekniske og yrkesfaglige områder, for eksempel maskinvare og programvare , ingeniørfag , kjemi , luftfart , robotikk , finans , medisin , forbrukerelektronikk , bioteknologi og skogbruk . Teknisk skriving omfatter det største underfeltet innen teknisk kommunikasjon.

The Society for Technical Communication definerer teknisk kommunikasjon som en hvilken som helst form for kommunikasjon som oppviser en eller flere av de følgende egenskaper: "(1) som kommuniserer om tekniske eller spesialiserte emner, for eksempel dataprogrammer, medisinske prosedyrer eller miljøbestemmelser, (2) kommuniserer ved å bruke teknologi, for eksempel websider, hjelpefiler eller sosiale medier, eller (3) gi instruksjoner om hvordan du gjør noe, uavhengig av hvor teknisk oppgaven er ".

Oversikt

Ytterligere informasjon: Teknisk skribent

Teknisk skriving utføres av en teknisk skribent (eller teknisk forfatter) og er prosessen med å skrive og dele teknisk informasjon i profesjonelle omgivelser. En teknisk skribents hovedoppgave er å formidle teknisk informasjon til en annen person eller part på den tydeligste og mest effektive måten som er mulig. Informasjonen som tekniske forfattere kommuniserer er ofte kompleks, så sterke skrive- og kommunikasjonsevner er avgjørende. Tekniske forfattere formidler ikke bare informasjon gjennom tekst, men de må også være dyktige med datamaskiner. Tekniske forfattere bruker et bredt spekter av programmer for å lage og redigere illustrasjoner , diagramprogrammer for å lage visuelle hjelpemidler og dokumentprosessorer for å designe, lage og formatere dokumenter.

Selv om teknisk skriving vanligvis er forbundet med online hjelp og brukermanualer , kan begrepet teknisk dokumentasjon dekke et bredere spekter av sjangere og teknologier. Pressemeldinger , notater , rapporter , business forslag , datablader , produktbeskrivelser og spesifikasjoner , tekniske dokumenter , CV og jobbsøknader er bare noen få eksempler på skriving som kan anses teknisk dokumentasjon. Noen typer teknisk dokumentasjon håndteres vanligvis ikke av tekniske forfattere. For eksempel er en pressemelding vanligvis skrevet av en PR -skribent, selv om en teknisk skribent kan ha innspill om teknisk informasjon som er inkludert i pressemeldingen.

Historie

Selv om teknisk skriving bare har blitt anerkjent som et yrke siden andre verdenskrig , kan røttene spores til den klassiske antikken . Kritikere nevner verkene til forfattere som Aristoteles som de tidligste formene for teknisk skriving. Geoffrey Chaucers verk, Treatise on the Astrolabe, er et tidlig eksempel på et teknisk dokument . De tidligste eksemplene på teknisk skriving stammer fra den gamle engelske perioden.

Med oppfinnelsen av den mekaniske trykkpressen , begynnelsen av renessansen og fremveksten av fornuftens alder , ble dokumentasjon av funn en nødvendighet. Oppfinnere og forskere som Isaac Newton og Leonardo da Vinci utarbeidet dokumenter som kroniserte oppfinnelsene og funnene deres. Selv om de aldri ble kalt tekniske dokumenter i løpet av publiseringsperioden, spilte disse dokumentene en avgjørende rolle i utviklingen av moderne former for teknisk kommunikasjon og skriving.

Feltet for teknisk kommunikasjon vokste under den industrielle revolusjonen . Det var et økende behov for å gi folk instruksjoner for bruk av de mer og mer komplekse maskinene som ble oppfunnet. Imidlertid, i motsetning til tidligere, hvor ferdigheter ble overlevert gjennom muntlige tradisjoner, var det ingen andre enn oppfinnerne som visste hvordan de skulle bruke disse nye enhetene. Skriving ble dermed den raskeste og mest effektive måten å spre informasjon på, og forfattere som kunne dokumentere disse enhetene var ønsket.

I løpet av 1900 -tallet gikk behovet for teknisk skriving i været, og yrket ble offisielt anerkjent. Hendelsene under første verdenskrig og andre verdenskrig førte til fremskritt innen medisin, militær maskinvare, datateknologi og romfartsteknologi. Denne raske veksten, kombinert med krigens hast, skapte et umiddelbart behov for godt designet dokumentasjon for å støtte bruken av disse teknologiene. Teknisk skriving var etterspurt i løpet av denne tiden, og "teknisk skribent" ble en offisiell jobbtittel under andre verdenskrig .

Etter andre verdenskrig førte teknologiske fremskritt til en økning i forbruksvarer og levestandard. Under etterkrigstiden så offentlige tjenester som biblioteker og universiteter, samt transportsystemer som busser og motorveier, betydelig vekst. Behovet for forfattere for å krønike disse prosessene økte. Det var også i denne perioden at store virksomheter og universiteter begynte å bruke datamaskiner. Spesielt i 1949 forfattet Joseph D. Chapline det første beregningstekniske dokumentet, en bruksanvisning for BINAC -datamaskinen.

Oppfinnelsen av transistoren i 1947 tillot datamaskiner å bli produsert billigere og innenfor innkjøpsområdet for enkeltpersoner og små bedrifter. Etter hvert som markedet for disse " personlige datamaskinene " vokste, vokste behovet for forfattere som kunne forklare og gi brukerdokumentasjon for disse enhetene. Yrket teknisk skriving så ytterligere ekspansjon i løpet av 1970- og 1980 -årene ettersom forbrukerelektronikk fant veien inn i hjemmene til flere og flere mennesker.

De siste årene har datamaskinens fremtredende plass i samfunnet ført til mange fremskritt innen digital kommunikasjon, noe som har ført til endringer i verktøyene tekniske forfattere bruker. Hypertekst , tekstbehandlere , grafikkredigeringsprogrammer og sidelayoutprogramvare har gjort opprettelsen av tekniske dokumenter raskere og enklere, og tekniske forfattere i dag må være dyktige i disse programmene.

Teknikker

God teknisk skriving er kortfattet, fokusert, lett å forstå, fri for feil og publikumsbasert. Tekniske forfattere fokuserer på å gjøre dokumentene så klare som mulig, unngå altfor tekniske setninger og stilistiske valg som passiv stemme og nominasjoner. Fordi tekniske dokumenter brukes i virkelige situasjoner, bør det alltid være eksplisitt klart hva emnet i et teknisk dokument er og hvordan du bruker den presenterte informasjonen. Det ville være katastrofalt hvis for eksempel en teknisk skribents instruksjoner om hvordan du bruker en kraftig røntgenmaskin var vanskelige å tyde.

Teknisk skriving krever at en skribent grundig undersøker publikummet sitt. En teknisk skribent må være oppmerksom på publikums eksisterende kunnskap om materialet de diskuterer, ettersom kunnskapsgrunnlaget for forfatterens publikum bestemmer innholdet og fokuset i et dokument. For eksempel vil en evalueringsrapport som diskuterer funn fra en vitenskapelig studie som er skrevet til en gruppe dyktige forskere, være veldig annerledes konstruert enn den som er beregnet for allmennheten. Tekniske forfattere trenger ikke å være fageksperter (SMB) selv. De samarbeider ofte med små og mellomstore bedrifter for å fullføre oppgaver som krever mer kunnskap om et emne enn de har.

Teknisk skriving må være nøyaktig. En teknisk skribent, etter å ha analysert publikummet sitt, vet hva de trenger for å kommunisere og må deretter formidle budskapet på en nøyaktig og etisk måte. Fysiske, miljømessige eller økonomiske konsekvenser kan oppstå hvis en forfatter gjør dette feil. Å kjenne publikum er avgjørende for nøyaktighet fordi språket vil bli skreddersydd i henhold til det de allerede forstår om emnet. For eksempel følger instruksjoner om hvordan du monterer en bokhylle riktig og sikkert. Disse instruksjonene er konstruert slik at hvem som helst kan følge med, inkludert nøyaktige detaljer om hvor hvert feste går. Hvis disse instruksjonene var unøyaktige, kan bokhyllen være ustabil og mislykkes.

Dokumentdesign og layout er også viktige komponenter i teknisk skriving. Tekniske forfattere bruker store mengder tid på å sikre at dokumentene er lesbare fordi et dårlig utformet dokument hemmer lesers forståelse. Teknisk dokumentdesign understreker riktig bruk av valg av dokumentdesign, som punkter, skriftstørrelse og fet tekst. Bilder, diagrammer og videoer brukes også ofte av tekniske forfattere fordi disse mediene ofte kan formidle kompleks informasjon, som selskapets årlige inntjening eller et produkts designfunksjoner, langt mer effektivt enn tekst.

Tekniske dokumenter

Teknisk skriving dekker mange sjangere og skrivestiler, avhengig av informasjon og publikum. Tekniske dokumenter er ikke bare produsert av tekniske forfattere. Nesten alle som jobber i profesjonelle omgivelser produserer tekniske dokumenter av en eller annen variasjon. Noen eksempler på teknisk dokumentasjon inkluderer:

  • Instruksjoner og prosedyrer er dokumenter som hjelper utviklere eller sluttbrukere med å betjene eller konfigurere en enhet eller et program. Eksempler på instruksjonsdokumenter inkluderer brukermanualer og feilsøkingsguider for dataprogrammer, maskinvare, husholdningsprodukter, medisinsk utstyr, mekaniske produkter og biler.
  • Forslag . De fleste prosjekter begynner med et forslag - et dokument som beskriver formålet med et prosjekt, oppgavene som skal utføres i prosjektet, metodene som brukes for å fullføre prosjektet, og til slutt kostnadene for prosjektet. Forslag dekker et bredt spekter av emner. For eksempel kan en teknisk skribent skrive et forslag som beskriver hvor mye det vil koste å installere et nytt datasystem, en markedsføringspersonale kan skrive et forslag med produkttilbudene, og en lærer kan skrive et forslag som beskriver hvordan en ny biologiklasse vil være strukturert.
  • E -post , brev og notater er noen av de mest skrevne dokumentene i en virksomhet. Brev og e -post kan konstrueres med en rekke mål - noen er vanligvis rettet mot å bare kommunisere informasjon, mens andre er designet for å overtale mottakeren til å utføre en bestemt oppgave. Mens brev vanligvis skrives til folk utenfor et selskap, er notater (notater) dokumenter skrevet til andre ansatte i virksomheten.
  • Pressemeldinger . Når et selskap ønsker å offentliggjøre et nytt produkt eller en ny tjeneste, vil de ha en forfatterforfatter en pressemelding . Dette er et dokument som beskriver produktets funksjoner og verdi for publikum.
  • Spesifikasjoner er designoversikter som beskriver strukturen, delene, emballasjen og leveringen av et objekt eller en prosess i så detaljert at en annen part kan rekonstruere det. For eksempel kan en teknisk skribent diagramme og skrive spesifikasjonene for en smarttelefon eller sykkel, slik at en produsent kan produsere objektet.
  • Beskrivelser er kortere forklaringer på prosedyrer og prosesser som hjelper leserne til å forstå hvordan noe fungerer. For eksempel kan en teknisk skribent skrive et dokument som viser effekten av klimagasser eller demonstrerer hvordan bremsesystemet på en sykkel fungerer.
  • Resuméer og jobbsøknader er et annet eksempel på tekniske dokumenter. De er dokumenter som brukes i profesjonelle omgivelser for å informere leserne om forfatterens legitimasjon.
  • Tekniske rapporter er skrevet for å gi leserne informasjon, instruksjoner og analyse for oppgaver. Rapporter kommer i mange former. For eksempel kan en teknisk skribent vurdere en bygning som er til salgs og lage en turrapport som fremhever funnene hans og om han eller hun mener bygningen bør kjøpes. En annen forfatter som jobber for et ideelt selskap kan publisere en evalueringsrapport som viser funnene fra selskapets forskning på luftforurensning.
  • Case study er en publisert rapport om en person, gruppe eller situasjon som har blitt studert over tid; også  : en situasjon i det virkelige liv som kan ses på eller studeres for å lære om noe. For eksempel er en persons utfordrende situasjon på arbeidsplassen hans og hvordan han eller hun løste det en casestudie.
  • Hvitbøker er dokumenter som er skrevet for eksperter på et felt og vanligvis beskriver en løsning på en teknologisk eller forretningsmessig utfordring eller et problem. Eksempler på meldinger inkluderer et stykke som beskriver hvordan du får en virksomhet til å skille seg ut på markedet eller et stykke som forklarer hvordan du kan forhindre cyberangrep på bedrifter.
  • Nettsteder . Fremkomsten av hypertekst har endret måten dokumenter blir lest, organisert og tilgjengelig på. Dagens tekniske forfattere er ofte ansvarlige for å lage sider på nettsteder som "Om oss" -sider eller produktsider. Det forventes ofte at de er dyktige i verktøy for webutvikling.
  • Dataark er dokumentene som oppsummerer funksjonene, viktige spesifikasjoner, tekniske egenskaper, applikasjonskretser og annen viktig informasjon om produktet, maskinen, utstyret, programvaren, applikasjonen eller systemet i korte trekk.
  • API -guider er skrevet for utviklerfellesskapet og brukes til å forklare programmeringsgrensesnittene for applikasjoner .
  • Hjelpesystemer er online hjelpesentre som gir brukerne teknisk informasjon om produkter og tjenester. De gir innhold som nettsider som vises i en nettleser. Innholdet kan opprettes i hjelpesenterprogramvare , for eksempel Zendesk , eller i hjelpeformeringsverktøy eller komponentinnholdshåndteringssystemer som kan opprette et hjelpesenter som en HTML -utgang.

Verktøy

Følgende verktøy brukes av tekniske forfattere til å skrive og presentere dokumenter:

  • Desktop -publiseringsverktøy eller tekstbehandlere . Tekniske forfattere bruker tekstbehandlere som Scrivener, Microsoft Word , Apple Pages og LibreOffice Writer til å skrive, redigere, designe og skrive ut dokumenter. Siden teknisk skriving handler like mye om sidelayout som skriftspråket, brukes også forbedrede desktop -publiseringsverktøy som Adobe InDesign og LyX . Disse programmene fungerer på samme måte som tekstbehandlere, men gir brukerne flere alternativer og funksjoner for dokumentets design og automatiserer mye av formateringen.
  • Hjelp til redigeringsverktøy . Disse brukes av tekniske forfattere til å lage hjelpesystemer som er pakket med programvareprodukter, levert gjennom nettlesere eller levert som filer brukerne kan se på datamaskinene. Når du skriver instruksjonsprosedyrer for å beskrive mekaniske, elektriske eller programvareprogrammer, bruker tekniske forfattere disse verktøyene for å hjelpe dem med å forenkle monterings-, drifts- eller installasjonsprosesser.
  • Komponentinnholdshåndteringssystemer . Disse brukes også av tekniske forfattere til å lage hjelpesystemer og dokumenter. Component Content Management Systems (CCMS) lar forfattere lage lignende utdata som redigeringsverktøy, men de tilbyr også innholdsstyringsfunksjoner som versjonsbehandling og innebygde arbeidsflyter.
  • Bildebehandlingsprogramvare . Ofte kan bilder og andre visuelle elementer kommunisere informasjon bedre enn tekstavsnitt. I disse tilfellene brukes bilderedigeringsprogramvare som Adobe Photoshop og GIMP av tekniske forfattere til å lage og redigere de visuelle aspektene ved dokumenter som bilder, ikoner og diagrammer.
  • Samarbeidsprogrammer. Fordi teknisk skriving ofte innebærer kommunikasjon mellom flere individer som jobber for forskjellige selskaper, kan det være et samarbeid. Tekniske forfattere bruker Wiki Systems og delte arbeidsområder for dokumenter for å jobbe med andre forfattere og parter for å konstruere tekniske dokumenter.
  • Verktøy for webutvikling . Tekniske forfatterjobber er ikke lenger begrenset til bare å produsere dokumenter. Noen ganger produserer de også innhold for selskapets bedrifts- og andre profesjonelle nettsteder. Det kan derfor forventes at tekniske forfattere er dyktige i verktøy for nettutvikling som Adobe Dreamweaver .
  • Tekstredaktører . Programmer som Microsoft Notisblokk , TextEdit eller Wordstar lar tekniske forfattere redigere ren tekst . Tekstredigeringsprogrammer kan brukes til å endre innhold, for eksempel konfigurasjonsfiler , dokumentasjon filer og programmeringsspråk kildekode . Tekstredaktører er mye brukt av tekniske forfattere som jobber med innhold på nettet.
  • Grafisk programvare. For å kommunisere statistisk informasjon, for eksempel antall besøk på en restaurant eller mengden penger et universitet bruker på sine sportsprogrammer, bruker tekniske forfattere grafer og flytskjemaer. Selv om programmer som Microsoft Excel og Word kan lage grunnleggende grafer og diagrammer, må noen ganger tekniske forfattere produsere mer komplekse og detaljerte grafer som krever funksjoner som ikke er tilgjengelige i disse programmene, og det kan være nødvendig å gå til graf- og diagramverktøy (f.eks. Microsoft Visio ).
  • Verktøy for skjermfangst. Tekniske forfattere bruker ofte verktøy for skjermopptak som Camtasia og Snagit . Når du lager instruksjoner for dataprogramvare, kan det være lettere for en teknisk skribent å bare ta opp en kort video av stasjonære datamaskiner mens de fullfører en oppgave enn det ville være å skrive en lang rekke instruksjoner som beskriver hvordan oppgaven må utføres. Verktøy for skjermopptak brukes også til å ta skjermbilder av programmer og programvare som kjører på brukerens datamaskiner og deretter lage tilhørende diagrammer.

Liste over foreninger

Referanser

Eksterne linker