teknisk skrivning er praksis med at behandle dokumenter og visuals, verbal information og demonstrationer til undervisningsmateriale. Formålet med teknisk skrivning er at levere materiale, der forklarer en proces eller gør et komplekst koncept lettere at forstå for et bestemt publikum. Gennem effektiv og effektiv teknisk skrivning vil forfatteren være i stand til at forklare og hjælpe læseren med at forstå information og udføre specifikke opgaver. Der er fem universelle etiske principper for teknisk skrivning. Principperne er kvalitetsindhold, publikum og formål, tilgængelighed, grammatik og skrivestil.
kvalitetsindhold
kvalitetsindhold er subjektivt. MATCS definition af indhold af høj kvalitet er et produkt, der opfylder en kundes standarder eller går ud over projektets oprindelige omfang. For at producere et projekt af høj kvalitet skal du skrive med det tilsigtede publikum i tankerne. Forfatteren skal undersøge yderligere viden, der er nødvendig, før dokumentet eller materialet er afsluttet. Forfatteren skal vide, hvilket format eller platform der skal bruges til at repræsentere Informationen. Forfatteren skal bestemme specifikke oplysninger, der spænder fra at vide, hvad fristerne er til at vide, hvorfor oplysningerne skal skrives.
publikum og formål
forfatteren skal forstå både formål og publikum for at skabe et fremragende teknisk stykke. Det tekniske skrivepublikum varierer afhængigt af branchen og den bestemte klient. For eksempel ville publikum af en lap-rapport være den produktfremstilling, der hyrede os som forfattere. Publikum for et eLearning-træningsmodul kan være en bank-eller realkreditudbyder, der har brug for compliance-træning. Forfatteren skal vide, hvor meget læserne vil vide, og hvilke ansvar forfatteren skal opfylde, når det kommer til at kommunikere til læserne.
tilgængelighed
det er vigtigt for publikum at kunne få adgang til de oplysninger, som forfatteren skabte med lethed. Tilgængelighed inkluderer alt, hvad der er på et dokument, såsom sidehoveder og sidefødder, eller på computer iLearn-moduler, som forbedrer tilgængelighedsformatering for at være mere universel og klarere. Den tekniske forfatter skal finde ud af den bedste metode til at hjælpe læserne med at navigere i dokumentationen med notationer fra en bibliografi til et sidetal til en indholdsfortegnelse. Forfatteren kunne endda tilføje visuals, såsom diagrammer og figurer, for at forklare information yderligere.
grammatik
Skrivning klar, kortfattet og ligetil med en korrekt brug af grammatik er afgørende for at skrive ethvert teknisk stykke. Forfatteren skal også korrekturlæse og redigere ethvert teknisk stykke, der skrives for at rette eventuelle fejl eller uoverensstemmelser med grammatikken, stil, og layout. En teknisk forfatter skal altid skrive i nutid, medmindre klienten angiver deres præference ellers. Læseren af det tekniske stykke skal gøre præcis, hvad du giver instruktioner til. Forfatteren skal altid skrive i enkle sætninger, der indeholder kønsneutrale navneord. Enkle sætninger hjælper læserne med klart og effektivt at forstå de opgaver, de skal påtage sig for at fuldføre deres mål.
skrivestil
skrivestilen adskiller sig for hvert teknisk stykke, fordi det stærkt afhænger af, hvem publikum er, og scenariet, som det tekniske stykke skrives til. Tonen i et teknisk skrivestykke er afgørende, fordi det hjælper læseren med at forstå, hvilken slags tone der kræves for at fuldføre opgaven. Ordvalg er også en væsentlig del af stilen til at hjælpe med at give publikums behov, fordi det forbinder tilbage til, hvem dit publikum er. Når der henvises til dele af oplysninger eller hjemmesider, er det vigtigt at give klare og synlige måder at få adgang til oplysningerne ved hjælp af værktøjer, såsom figurer og tabeller.
andre tekniske skrivetips
gør ekstra forskning og Lær mere
at kende det absolutte minimum får muligvis ikke det bedste tekniske stykke til at hjælpe publikum med at forstå informationen. Der kan være en masse terminologi, som både forfatteren og læseren måske ikke forstår. Som tommelfingerregel, Hvis du som læser ikke forstår et koncept eller udtryk, skal du definere det. For meget information kan altid skæres ned i senere anmeldelser. Disse oplysninger bør undersøges for at forstå, hvordan det virker med, hvad forfatteren skriver som helhed. Undersøg en lille far og find ud af, hvilke andre oplysninger der kan bruges til at forbedre det tekniske stykke, der skrives.
Bliv publikum og undervurder publikum
sæt dig selv i publikums sko. Kan du klart forstå og følge de instruktioner eller oplysninger, du har skrevet til publikum? Hvis ja, kan du give flere oplysninger, hvis du mener, at det har brug for lidt mere hjælp. Hvis ikke, skal du finde de dele, der ikke er klare, og finde en måde at give oplysningerne korrekt på. Et stort problem, som tekniske forfattere ofte har, er, at de overvurderer deres publikums viden. Publikum kunne være flere mennesker på forskellige niveauer af viden. Det er helt acceptabelt at kort give oplysninger, der kunne antages eller allerede er angivet som en genopfriskning for publikum.
Bed om en anden og tredje udtalelse og fagfællebedømmelse
tekniske forfattere er opfindsomme. Den største ressource, du har, er dine fageksperter. Sørg for at spørge din SMV, hvis de ser nogen viden huller eller fejl. Forfattere tjekke med deres kunder for at se, om der er nogen viden huller eller fejl, at forfatteren kan overse. At have en vejleder eller kollega til at kigge over og give en mening kan også hjælpe med at forbedre et teknisk stykke. Fagfællebedømmelse er, når en gruppe mennesker mødes for at læse, kommentere og anbefale forbedringer af hinandens arbejde. Flere blinde pletter bliver afdækket, når flere mennesker gennemgår et dokument, hvilket sikrer nøjagtige og koncise oplysninger.
tekniske forfattere lærer nye oplysninger for hvert projekt, de arbejder på. Forfatterne får en bedre forståelse af, hvad klienter har brug for, fordi de starter under deres læsers videnniveau før al forskning og diskussioner med emneeksperterne. Dette bliver et stort aktiv for virksomhederne, fordi mindre antagelser åbner op for mere effektiv uddannelse. Kombinationen af de forfattere, der lærer materialet og disse etiske principper for tekniske skrivestandarder, fører til mere selvsikre og effektive medarbejdere.