Om du har anklagats för att skriva ett dokument som ska instruera någon annan hur man gör något, kastar dagens sätt att göra det mer eller mindre de gamla metoderna ut genom fönstret.
1. Stora bombastiska rubriker
Du kommer att märka att rubrikerna på PCMech, till exempel den ovanför denna mening, är enorma. Det beror på att de är lättare att se, läsa och veta var du befinner dig i dokumentet.
2. Mindre ord
Fel väg:
Följande dokumentation förklarar hur man använder och använder Fanny Whacker 2000.
Rätt väg:
Instruktioner för hur du använder Fanny Whacker 2000
Kom alltid ihåg denna fras när du skriver dokumentation: FÅ PÅ PUNKTET SOM HAST SOM MÖJLIGT.
3. Hoppa över värdelösa referenser
Om referensen inte har något att göra med kärninstruktionen för vad du försöker beskriva, till exempel:
För mer information om Fanny Whacker 2000: s Turnip Twaddler, se dokument FU, underavsnitt ID10T.
… gör inte det.
4. Datum det. Alltid.
Datumet då dokumentationen skrevs skulle vara i sidfotområdet på varje sida. Om det är ett elektroniskt dokument visas datumet två gånger. En gång i början, en gång i slutet.
Du kan skriva detta som "Senast reviderad (infoga datum här)".
5. Varningar bör alltid skickas före återvändandepunktet
Om det finns något i din dokumentation som potentiellt kan skada / förstöra / utplåna något om det utförs fel, bör denna information placeras direkt efter den nämnda instruktionen, vara synlig (betyder på samma sida) och accentueras.
Exempel:
Steg 5. Rengöring av Fanny Whacker 2000
FW2000: s paddlar ska rengöras försiktigt med en mjuk trasa som inte slipar.
VARNING: Använd endast ammoniakfritt lösningsmedel för att förhindra att FW2000 exploderar och resulterar i din tidiga död.
Till sist, bra dokumentation kommer inte från att vara superbeskrivande om varje möjlig tänkbar sak. Läs din dokumentation och fråga dig själv, instruerar den ordentligt? Om svaret är ja, är nästa fråga, instruerar det snabbt ? Om ja, är dokumentationen bra.
