Fem tips for å skrive Stor teknisk Documentation

Opprette teknisk dokumentasjon er en del av å gjøre arbeidet i IT-bransjen. Tekniske manualer, tekniske spesifikasjoner instruksjoner, støtte guider, implementering manualer - hver er typer teknisk dokumentasjon, og er en del av jobben. Mange tekniske roller i IT-bransjen ta del i prosessen dokumentasjon. Det kan bare virke grei å bare sette noen ord og diagrammer sammen, en innholdsfortegnelse og tenke på det som et teknisk dokument, men det &'; s litt mer enn det. I &'; ve oppført fem tips nedenfor om hvordan du skriver gode tech docs

Bruk en godt strukturert Innhold

Innholdsfortegnelsen er blant de viktigste delen av et dokument.. Innholdsfortegnelsen viser hva som er faktisk i dokumentet og hvordan det er ordnet. Den brukes til å hjelpe brukerne med å forstå at dokumentet gir den informasjonen de leter etter. Undersøke innholdsfortegnelsen, er de i stand til enkelt å se om den har det de trenger, eller om de trenger å lese et annet dokument.

En ekstra fordel av å ha et godt strukturert innholdsfortegnelse er det lar leseren å finne den informasjonen de trenger raskt. Microsoft Word, Adobe PDF og også andre dokument programmer lar klikkbare lenker i innholdsfortegnelsen. Dette gjør at du kan klikke på elementet eller sidetallet, og det vil ta deg til den siden. . Veldig nyttig for å finne emner raske

være konsis Men Grundig

Å være et teknisk dokument forfatter, det &'; s vanskelig å virkelig vite hva beløpet og hva slags informasjon til å sette inn i dette dokumentet. For å skrive en stor dokument, kan du prøve å være kort, men grundig. Hva dette betyr er ikke til å gå av og på, og i alle slags detaljer om visse områder som ikke er nødvendige av leseren. Det er ikke lett å si hva &'; s relevant og hva isn &'; t - men gjør et forsøk på å vurdere leseren og målgruppen når du &'; re å skrive ut dokumentet. Hvis du er for “ ordrike &"; eller bruke for mye informasjon der det &'; s unødvendig, det vil slå leserne av og den vant &';. t være en effektiv dokument

Vær konsekvent gjennom hele dokumentet

Konsistens er en viktig måte å forbedre et dokument. Den vil gjøre det ser mer profesjonell, og faktisk mer lesbar for brukeren. Når jeg sier konsistens, mener jeg regularitet både i lingo du bruker, og formater søker. Enkelte individer vant &'; t merke dette. Likevel, hvis du &'; re komponere et teknisk dokument, det &'; s mer enn sannsynlig for andre tekniske brukere, som vanligvis er detaljfokuserte mennesker. Sikre dokumentet bruker samme formatering hele. Prøv å bryte data opp og gjøre det forståelig for brukerne ved å gjøre bruk av hvitt plass effektivt.

Ved hjelp av de samme uttrykkene er også anbefalt. Dette vil trolig sørge for at brukeren vet du &'; re skrive om det samme ved å bruke de samme ordene. Hvis du bruker ordene om hverandre, for eksempel “ desktop &" ;, “ PC &" ;, “ datamaskinen &" ;, det kunne forvirre brukeren, når du faktisk mener det samme. At &'; s raskt eksempel, men ideen er at du bør velge ett semester og fortsette med det

Keep It Nøyaktig og feilfri

Det sier nesten seg selv at teknisk dokumentasjon egentlig. bør være feilfri. Som jeg har nevnt ovenfor, vil mange lesere av dokumentet være andre tekniske brukere, og det &'; s en ganske god mulighet feilene vil skille seg ut til dem. I tillegg til det, hvis feilene don &'; t hoppe ut, da det gir dem feil informasjon om systemet eller området du &';! Re dokumentere - som nederlagene formålet med dokumentet

Unngå stor skjerm Fanger

Å gjøre bruk av skjermbilder eller skjerm innenfor dokumentasjon er definitivt en effektiv måte å forklare poenget ditt til leseren. Det &'; s først og fremst nyttig for programvare dokumentasjon eller støtteprosesser, som er lett å ta skjermbilder av. Imidlertid har dataskjermer fått større med årene, men A4-ark har alltid vært den samme størrelsen.

Dette etterlater en tilbøyelighet til å innlemme store skjermbilder i et dokument, som gjør skjerm liten og ineffektiv. Inkludert skjerm er en god idé - don &'; t misforstå - men gjøre en innsats for å bare inkludere de områdene som er knyttet til den delen du &'; re forklare. Dette har en tendens til å føre til flere skjermbilder, men de vil være mer effektivt og gjøre dokumentet mer lesbar
.