Hvis du har blitt tiltalt for å skrive et dokument som skal instruere noen andre hvordan du gjør noe, kaster dagens måte å gjøre det mer eller mindre på de gamle metodene ut av vinduet.
1. Store bombastiske overskrifter
Du vil merke at topptekstene på PCMech, for eksempel den som er rett over denne setningen, er enorme. Dette er fordi de er lettere å se, lese og vite hvor du er i dokumentet.
2. Mindre ord
Feil vei:
Følgende dokumentasjon forklarer hvordan du bruker og bruker Fanny Whacker 2000.
Riktig måte:
Instruksjoner for hvordan du bruker Fanny Whacker 2000
Husk alltid denne frasen når du skriver dokumentasjon: BLI PÅ PUNKTET SOM RASKT SOM ER MULIG.
3. Hopp over ubrukelige referanser
Hvis referansen ikke har noe å gjøre med kjerneanvisningen til det du prøver å beskrive, for eksempel:
For mer informasjon om Fanny Whacker 2000s Turnip Twaddler, se dokument FU, underavsnitt ID10T.
… ikke gjør det.
4. Dato det. Bestandig.
Datoen for dokumentasjonen ble skrevet i bunntekstområdet på hver side. Hvis det er et elektronisk dokument, vises datoen to ganger. En gang i begynnelsen, en gang på slutten.
Du kan skrive dette som "Sist revidert (sett inn dato her)".
5. Advarsler skal alltid legges før tilbakekomsten
Hvis det er noe i dokumentasjonen din som potensielt kan skade / ødelegge / utslette noe hvis den blir utført feil, bør denne informasjonen plasseres rett etter nevnte instruksjon, være i tydelig syn (som betyr på samme side) og aksent.
Eksempel:
Trinn 5. Rengjøring av Fanny Whacker 2000
FW2000s padler skal rengjøres forsiktig med en myk klut som ikke slipper.
ADVARSEL: Bruk bare ammoniakkfritt løsningsmiddel for å forhindre at FW2000 eksploderer og resulterer i din utidige død.
Til slutt kommer ikke god dokumentasjon fra å være superbeskrivende om alle mulige tenkelige ting. Les dokumentasjonen og spør deg selv, instruerer den ordentlig? Hvis svaret er ja, er neste spørsmål, instruerer det raskt ? Hvis ja, er dokumentasjonen god.
