Fem tips til at skrive Great Teknisk dokumentation

Oprettelse teknisk dokumentation er en del af at gøre arbejdet i it-branchen. Tekniske manualer, teknisk specifikation instruktioner, support guider, implementering manualer - hver er typer af teknisk dokumentation og er en del af jobbet. En masse tekniske roller i IT-branchen deltager i dokumentationen processen. Det kunne bare synes ligetil at bare sætte nogle ord og diagrammer sammen, en indholdsfortegnelse og tænke på det som et teknisk dokument, men det &'; s lidt mere end det. I &'; ve opført fem tips nedenfor om hvordan man skriver store tech docs

Brug en velstruktureret Indholdsfortegnelse

Indholdsfortegnelsen er blandt de vigtigste afsnit i et dokument.. Indholdsfortegnelsen viser, hvad der er i virkeligheden i dokumentet, og hvordan det er arrangeret. Det bruges til at hjælpe brugerne med at forstå, at dokumentet indeholder de oplysninger, de søger. Undersøgelse indholdsfortegnelsen, de er i stand til nemt at se, om det har, hvad de har brug for, eller hvis de har brug for at læse et andet dokument.

En yderligere fordel ved at have en velstruktureret indholdsfortegnelse det giver læseren at finde de oplysninger, de har brug hurtigt. Microsoft Word, Adobe PDF og også andre dokumentprogrammerne tillade klikbare links i indholdsfortegnelsen. Dette gør det muligt at klikke på elementet eller sidetallet, og det vil tage dig til den pågældende side. . Meget nyttigt til at finde emner hurtigt

Vær kortfattet, men Grundig

At være en teknisk dokument forfatter, det &'; s svært at virkelig vide, hvad beløb og hvilken slags oplysninger til at sætte ind i dette dokument. For at skrive en stor dokument, så prøv at gøre det kort, men grundig. Hvad dette betyder er ikke at gå på og på og i alle former for detaljer om visse områder, der ikke er nødvendige af læseren. Det er ikke let at fortælle, hvad &'; s relevante og hvad isn &'; t - men gør et forsøg på at overveje læseren og målgruppe, når du &'; re at skrive dokumentet. Hvis du er for “ ordrige &"; eller bruger for meget information, hvor det &'; s unødvendigt, det vil slå læserne fra, og den vandt &';. t være en effektiv dokument

Vær konsekvent i hele dokumentet

Sammenhæng er en vigtig måde at forbedre et dokument. Det vil gøre det ser mere professionelle, og i virkeligheden mere læsbar for brugeren. Når jeg siger konsistens, mener jeg regelmæssighed både i lingo du bruger, og formateringen søger. Nogle personer vandt &'; t bemærke dette. Ikke desto mindre, hvis du &'; re komponere et teknisk dokument, det &'; s mere end sandsynligt for andre tekniske brugere, der normalt detaljerige fokuserede mennesker. Sikre dit dokument bruger den samme formatering overalt. Prøv at bryde data op og gøre det forståeligt for brugerne ved at gøre brug af hvid plads effektivt.

Brug de samme udtryk er også anbefales. Dette vil sandsynligvis sikre, at brugeren kender dig &'; re at skrive om det samme ved at bruge de samme ord. Hvis du benytter ord i flæng, for eksempel “ desktop &" ;, “ PC &" ;, “ computer &" ;, det eventuelt kunne forvirre brugeren, når du rent faktisk betyder det samme. At &'; s hurtigt eksempel, men ideen er, at du skal vælge den ene sigt og ophold med det

Keep It Præcis og fejlfri

Det siger næsten sig selv, at teknisk dokumentation rigtig. bør være fejlfri. Som jeg sagde ovenfor, vil en hel del læsere af dokumentet være andre tekniske brugere, og der &'; s temmelig god mulighed fejlene vil skille sig ud til dem. Ud over, at hvis fejlene don &'; t springe ud, så det giver dem med de forkerte oplysninger om systemet eller område, som du &';! Re dokumentere - som besejrer formålet med dokumentet

Undgå Stor skærm Optager

Gør brug af skærmbilleder eller skærmbilleder i din dokumentation er absolut en effektiv måde at forklare din point til læseren. Det &'; s primært nyttigt for software dokumentation eller støtte processer, der er let at tage skærmbilleder af. Imidlertid har computerskærme fået større gennem årene, men A4 ark har altid været den samme størrelse.

Dette efterlader en tilbøjelighed til at indarbejde store screenshots i et dokument, som gør screenshots små og ineffektive. Herunder screenshots er en fantastisk idé - don &'; t få mig forkert - men gøre en indsats for kun omfatte de områder, der er relateret til det afsnit, du &'; re at forklare. Denne tendens til at føre til flere skærmbilleder, men de vil være mere effektive og gøre dokumentet mere læsbart
.