grundlæggende principper for teknisk skrivning

nu og da er vi nødt til at revidere de grundlæggende principper for teknisk skrivning. Siden vi startede i 1997, har de grundlæggende principper for teknisk skrivning været de samme, selv når kommunikationsmåderne ændres.

formål og publikum

før du begynder et nyt skriveprojekt, skal en teknisk forfatter analysere formålet med dokumentet og identificere det tilsigtede publikum. Forfatteren skal spørge:

• hvem læser dokumentationen?
• Hvad er deres fordomme?
• hvilket ansvar har jeg, når jeg kommunikerer information til publikum?

stilguide

tekniske forfattere bruger ofte en virksomhedsstilguide, hvis den er tilgængelig, for at sikre, at deres dokumentation har et struktureret mønster. En stilguide (såsom AP Stylebook) indeholder retningslinjer for, hvordan et dokument ser ud, det sprog, det bruger, og hvordan ideer arrangeres. Denne organisation giver kontinuitet til et dokument eller en række dokumenter, så publikum nemt kan forstå oplysningerne. For eksempel kan en teknisk forfatter dokumentere en proces kronologisk, som dikteret i stilguiden. Uden denne struktur ville læseren være forvirret og ude af stand til at følge processen. Stilguider gør skrivning mere konsistent og læsbar.

skrivestil

tekniske forfattere ændrer deres skrivestil afhængigt af publikum og den situation, de skriver om. Hvis de skriver teknisk dokumentation, skal stilen være formel, blottet for de følelser, du får med kreativ skrivning. Hvis de skriver en e-mail til en af de øverste ledere, der er involveret i projektet, ville deres stil være mere samtale.

adgang til oplysningerne

tilgængelighed er, hvor let oplysningerne i et dokument kan fås af det tilsigtede publikum. Et teknisk dokument indeholder elementer som en indholdsfortegnelse, overskrifter, sidefødder og sidetal for at hjælpe læserne med at navigere i dokumentet og finde de oplysninger, de har brug for. Et teknisk dokument overholder også en specifik struktur af overskrifter og underoverskrifter for at opdele oplysningerne i relevante afsnit, som læseren let kan få adgang til.

dette er blot nogle af de aspekter, vi behandler som tekniske forfattere. Hvis du vil forbedre dine egne tekniske skrivefærdigheder, kan du overveje vores tekniske skriveværksted. Det kan tilpasses til at imødekomme behovene hos 1 person eller 20 personer!

hvis du ikke selv ønsker at skrive dokumentet og har brug for hjælp fra en erfaren teknisk forfatter, kan du tjekke vores Serviceside.

vi er her for at hjælpe. Kontakt os i dag!