Hvis du er tiltalt for at skrive et dokument, der skal instruere en anden, hvordan man gør noget, kaster dagens måde at gøre det mere eller mindre på de gamle metoder ud af vinduet.

1. Store bombastiske overskrifter

Du vil bemærke, at overskrifterne på PCMech, såsom den lige over denne sætning, er enorme. Dette er fordi de er lettere at se, læse og vide, hvor du er i dokumentet.

2. Mindre ord

Forkerte vej:

Følgende dokumentation forklarer, hvordan man bruger og betjener Fanny Whacker 2000.

Rigtige måde:

Instruktioner til brug af Fanny Whacker 2000

Husk altid denne sætning, når du skriver dokumentation: FÅ TIL PUNKTET SOM HURTT SOM ER MULIG.

3. Spring over ubrugelige referencer

Hvis referencen ikke har noget at gøre med den centrale instruktion om, hvad du forsøger at beskrive, såsom:

For yderligere information om Fanny Whacker 2000's Turnip Twaddler, se dokument FU, underafsnit ID10T.

... gør ikke det.

4. Dato det. Altid.

Datoen for, hvor dokumentationen blev skrevet, skal være i sidefodsområdet på hver side. Hvis det er et elektronisk dokument, vises datoen to gange. Én gang i begyndelsen, en gang ved slutningen.

Du kan skrive dette som "Sidst revideret (indsæt dato her)".

5. Advarsler skal altid bogføres før tilbagevenden

Hvis der er noget i din dokumentation, der potentielt kan beskadige / ødelægge / udslette noget, hvis det udføres forkert, skal disse oplysninger placeres direkte efter nævnte instruktion, være i synet (betydning på den samme side) og accentueres.

Eksempel:

Trin 5. Rengøring af Fanny Whacker 2000 FW2000's skovle skal rengøres forsigtigt ved hjælp af en ikke-slibende blød klud. ADVARSEL: Brug kun ammoniakfrit opløsningsmiddel for at forhindre, at FW2000 eksploderer og resulterer i din tidlige død.

I sidste ende er god dokumentation ikke fra at være superbeskrivende om enhver mulig tænkelige ting. Læs din dokumentation og spørg dig selv, instruerer den korrekt? Hvis svaret er ja, er det næste spørgsmål, instruerer det hurtigt? Hvis ja, er dokumentationen god.