Če ste bili zadolženi za pisanje dokumenta, ki naj bi nekomu drugemu naročil, kako nekaj storiti, današnji način tega bolj ali manj vrže stare metode skozi okno.
1. Velike bombastične glave
Opazili boste, da so glave PCMech-a, kot je ta nad tem stavkom, ogromne. To je zato, ker jih lažje vidijo, berejo in vedo, kje ste v dokumentu.
2. Manj besed
Napačen način:
Naslednja dokumentacija razlaga, kako uporabljati in uporabljati Fanny Whacker 2000.
Prava pot:
Navodila za uporabo Fanny Whacker 2000
Pri pisanju dokumentacije si vedno zapomnite to besedno zvezo: PRIDOBITE DO TOČKE HITRO KOT MOŽNO.
3. Preskočite neuporabne reference
Če sklic nima nič skupnega z osnovnim navodilom tega, kar poskušate opisati, na primer:
Za dodatne informacije o Turnip Twaddlerju Fanny Whacker 2000 glejte dokument FU, pododdelek ID10T.
… Ne delaj tega.
4. Datum datum. Nenehno.
Datum, ko je bila dokumentacija napisana, mora biti v območju spodnjega dela vsake strani. Če gre za elektronski dokument, se datum prikaže dvakrat. Enkrat na začetku, enkrat na koncu.
To lahko napišete kot "Zadnji pregled (tukaj vstavite datum)".
5. Opozorila morajo biti vedno objavljena pred vrnitvijo
Če je v vaši dokumentaciji nekaj, kar bi lahko nepravilno poškodovalo / uničilo / izbrisalo, bi bilo treba te podatke dati neposredno po navedenem navodilu, biti na vidiku (kar pomeni na isti strani) in nanje poudariti.
Primer:
Korak 5. Čiščenje Fanny Whacker 2000
Vesla FW2000 je treba nežno očistiti z neabrazivno mehko krpo.
OPOZORILO: Uporabljajte le topilo brez amoniaka, da preprečite, da bi FW2000 eksplodiral in posledično do vaše prezgodnje smrti.
Za konec še dobro, da dobra dokumentacija ne pomeni, da je super opisen o vsaki možni stvari, ki jo je mogoče zamisliti. Preberite svojo dokumentacijo in se vprašajte, ali to pravilno daje pouk? Če je odgovor pritrdilen, je naslednje vprašanje, ali poučuje hitro ? Če je odgovor da, je dokumentacija dobra.
