Teknisk skriving er praksisen med å behandle dokumenter og visuelle, verbal informasjon og demonstrasjoner til undervisningsmateriell. Formålet med teknisk skriving er å gi materiale som forklarer en prosess eller gjøre et komplekst konsept lettere å forstå for et bestemt publikum. Gjennom effektiv teknisk skriving vil forfatteren kunne forklare og hjelpe leseren hvordan man forstår informasjon og utfører bestemte oppgaver. Det er fem universelle etiske prinsipper for teknisk skriving. Prinsippene er kvalitetsinnhold, publikum og formål, tilgjengelighet, grammatikk og skrivestil.
Kvalitetsinnhold
Kvalitetsinnhold er subjektivt. MATCS definisjon av innhold av høy kvalitet er et produkt som oppfyller kundens standarder eller går utover det opprinnelige omfanget av prosjektet. For å produsere et kvalitetsprosjekt må du skrive med det tiltenkte publikum i tankene. Forfatteren må undersøke ytterligere kunnskap som trengs før dokumentet eller materialet er fullført. Forfatteren må vite hvilket format eller plattform som skal brukes til å representere informasjonen. Forfatteren må bestemme spesifikk informasjon som spenner fra å vite hva tidsfrister er å vite hvorfor informasjonen må skrives.
Målgruppe Og Formål
forfatteren må forstå både formål og publikum for å skape et fremragende teknisk stykke. Teknisk skriving publikum varierer på bransjen og bestemt klient. For eksempel, publikum av en runde rapport ville være produktet produksjon som hyret oss som forfattere. Publikum for en eLearning opplæringsmodul kan være en bank eller boliglån leverandør som trenger compliance trening. Forfatteren har å vite hvor mye leserne vil vite og hva ansvar forfatteren er nødvendig for å oppfylle når det gjelder å kommunisere til leserne.
Tilgjengelighet
det er viktig for publikum å kunne få tilgang til informasjonen forfatteren opprettet med letthet. Tilgjengelighet inkluderer alt som er på et dokument, for eksempel topp-og bunntekster, eller på datamaskin iLearn-moduler, som forbedrer tilgjengelighetsformateringen slik at den blir mer universell og klarere. Den tekniske forfatteren må finne ut den beste metoden for å hjelpe leserne til å navigere i dokumentasjonen med notater fra en bibliografi til et sidetall til en innholdsfortegnelse. Forfatteren kan til og med legge til bilder, for eksempel diagrammer og figurer, for å forklare informasjon videre.
Grammatikk
Skrive klar, konsis og grei med riktig bruk av grammatikk er viktig i å skrive noen tekniske stykke. Forfatteren må også korrekturlese og redigere ethvert teknisk stykke som skrives for å rette eventuelle feil eller uoverensstemmelser med grammatikk, stil og layout. En teknisk forfatter bør alltid skrive i nåtid med mindre klienten angir deres preferanse ellers. Leseren av det tekniske stykket bør gjøre akkurat det du gir instruksjoner for. Forfatteren skal alltid skrive i enkle setninger som inkluderer kjønnsnøytrale substantiver. Enkle setninger hjelper leserne tydelig og effektivt å forstå oppgavene de må påta seg for å fullføre sine mål.
Skrivestil
skrivestilen er forskjellig for hvert teknisk stykke fordi det er tungt avhengig av hvem publikum er og scenariet som det tekniske stykket skrives for. Tonen i et teknisk skrivestykke er viktig fordi det hjelper leseren å forstå hva slags tone som kreves for å fullføre oppgaven. Ordvalg er også en viktig del av stilen i å hjelpe gi behovene til publikum fordi det kobles tilbake til hvem publikum er. Når du refererer til deler av informasjon eller nettsteder, er det viktig å gi klare og synlige måter å få tilgang til informasjonen ved hjelp av verktøy, for eksempel figurer og tabeller.
Andre Tekniske Skrivetips
Gjør Ekstra Forskning Og Lær Mer
Å Vite minimum kan ikke få det beste tekniske stykket for å hjelpe publikum å forstå informasjonen. Det kan være mye terminologi som både forfatteren og leseren kanskje ikke forstår. Som en tommelfingerregel, hvis du som leser ikke forstår et konsept eller begrep, definer det. For mye informasjon kan alltid kuttes ned i senere vurderinger. Denne informasjonen bør undersøkes for å forstå hvordan det fungerer med hva forfatteren skriver som helhet. Forskning litt far og finne ut hva annen informasjon kan brukes til å forbedre den tekniske stykke blir skrevet.
Bli Publikum Og Undervurder Publikum
Sett deg selv i publikums sko. Kan du tydelig forstå og følge instruksjonene eller informasjonen du har skrevet for publikum? Hvis ja, kan du gi mer informasjon hvis du tror det trenger litt mer hjelp. Hvis ikke, må du finne de delene som ikke er klare og finne en måte å gi informasjonen på riktig måte. Et stort problem som tekniske forfattere ofte har, er at de overvurderer kunnskapen til publikum. Publikum kan være flere personer på ulike nivåer av kunnskap. Det er helt akseptabelt å kort gi informasjon som kan antas eller allerede oppgitt som en oppfriskning for publikum.
Be om En Andre Og Tredje Mening Og Fagfellevurdering
Tekniske forfattere er ressurssterke. Den største ressursen du har er fageksperter. Sørg for å spørre SMB hvis de ser noen kunnskapshull eller feil. Forfattere sjekke med sine kunder for å se om det er noen kunnskapshull eller feil som forfatteren kan overse. Å ha en veileder eller kollega se over og gi en mening kan også bidra til å forbedre et teknisk stykke. Peer review er når en gruppe mennesker møtes for å lese, kommentere og anbefale forbedringer på hverandres arbeid. Flere blinde flekker blir avdekket når flere går gjennom et dokument, noe som sikrer nøyaktig og kortfattet informasjon.
Tekniske forfattere lærer ny informasjon for hvert prosjekt de jobber med. Forfatterne får en bedre forståelse av hva kundene trenger fordi de starter under kunnskapsnivået til sine lesere før all forskning og diskusjoner med fageksperter. Dette blir en stor ressurs for selskaper fordi mindre forutsetninger åpner for mer effektiv opplæring. Kombinasjonen av forfattere som lærer materialet og disse etiske prinsippene for tekniske skrivestandarder fører til mer selvsikker og effektiv ansatte.