Grunnleggende Prinsipper For Teknisk Skriving

nå og da må vi revidere de grunnleggende prinsippene for teknisk skriving. Siden vi startet i 1997, har de grunnleggende prinsippene for teknisk skriving vært de samme, selv om kommunikasjonsmodusene endres.

Formål Og Publikum

før du begynner på et nytt skriveprosjekt, må en teknisk forfatter analysere formålet med dokumentet og identifisere det tiltenkte publikum. Forfatteren må spørre:

• Hvem skal lese dokumentasjonen?
• Hva er deres forstyrrelser?
• hvilket ansvar har jeg når jeg formidler informasjon til publikum?

Stilveiledning

Tekniske forfattere bruker ofte en firmastilveiledning, hvis tilgjengelig, for å sikre at dokumentasjonen har et strukturert mønster. En stilguide (FOR EKSEMPEL AP Stylebook) gir retningslinjer for hvordan et dokument ser ut, språket det bruker, og hvordan ideer er ordnet. Denne organisasjonen gir kontinuitet til et dokument eller en serie dokumenter, slik at publikum lett kan forstå informasjonen. For eksempel kan en teknisk forfatter dokumentere en prosess kronologisk, som diktert i stilveiledningen. Uten denne strukturen ville leseren være forvirret og ute av stand til å følge prosessen. Stilguider gjør skriving mer konsekvent og lesbar.

Skrivestil

Tekniske forfattere endrer skrivestil avhengig av publikum og situasjonen de skriver om. Hvis de skriver teknisk dokumentasjon, bør stilen være formell, uten følelsene du får med kreativ skriving. Hvis de skriver en e-post til en av de øverste lederne som er involvert i prosjektet, vil deres stil være mer konverserende.

Tilgang Til Informasjonen

Tilgjengelighet er hvor lett informasjonen i et dokument kan innhentes av sitt tiltenkte publikum. Et teknisk dokument inneholder elementer som en innholdsfortegnelse, topptekst, bunntekst og sidetall for å hjelpe leserne med å navigere i dokumentet og finne informasjonen de trenger. Et teknisk dokument overholder også en bestemt struktur av overskrifter og underoverskrifter for å bryte informasjonen inn i relevante seksjoner som leseren lett kan få tilgang til.

Dette er bare noen av aspektene vi adresserer som tekniske forfattere. Hvis du vil forbedre dine egne tekniske skriveferdigheter, bør du vurdere Vår Tekniske Skriveverksted. Det kan tilpasses for å møte behovene til 1 person eller 20 personer!

hvis du ikke vil skrive dokumentet selv og trenger hjelp fra en erfaren teknisk forfatter, sjekk Ut Vår Tjenesteside.

Vi er her for å hjelpe. Kontakt oss i dag!