Ako su vas optužili za pisanje dokumenta koji bi trebao uputiti nekoga drugog kako nešto učiniti, današnji način da to učinite više ili manje baca stare metode kroz prozor.
1. Velika bombastična zaglavlja
Primijetit ćete da su zaglavlja na PCMech-u, poput onoga desno iznad ove rečenice, ogromna. To je zato što ih je lakše vidjeti, čitati i znati gdje se nalazite u dokumentu.
2. Manje riječi
Pogrešan način:
Sljedeća dokumentacija objašnjava kako koristiti i rukovati Fanny Whacker 2000.
Pravi put:
Upute za uporabu Fanny Whacker 2000
Uvijek zapamtite ovu frazu dok pišete dokumentaciju: DOđite do točke KAO BRZO KAO MOGUĆE.
3. Preskočite beskorisne reference
Ako referenca nema nikakve veze sa osnovnom uputom onoga što pokušavate opisati, kao što je:
Za daljnje informacije o Fanny Whacker 2000 Turnip Twaddler, pogledajte dokument FU, pododjeljak ID10T.
… nemoj to raditi.
4. Datumi. Stalno.
Datum kada je dokumentacija napisana treba biti u podnožju podnožja svake stranice. Ako se radi o elektroničkom dokumentu, datum se prikazuje dva puta. Jednom na početku, jednom na kraju.
To možete napisati kao "Posljednji put revidiran (ovdje unesite datum)".
5. Upozorenja uvijek trebaju biti objavljena prije točke u kojoj nema povratka
Ako u vašoj dokumentaciji postoji nešto što bi moglo potencijalno oštetiti / uništiti / izbrisati ako se pogrešno izvodi, te podatke treba staviti neposredno nakon navedene upute, biti na vidjelo (znači na istoj stranici) i naglasiti.
Primjer:
Korak 5. Čišćenje Fanny Whacker 2000
Vesla FW2000 treba pažljivo očistiti neabrazivnom mekom krpom.
UPOZORENJE: Koristite samo otapalo bez amonijaka da spriječite da FW2000 eksplodira i što rezultira vašom preranom smrću.
Za kraj, dobra dokumentacija nije od super opisivanja svake moguće zamisli. Pročitajte svoju dokumentaciju i zapitajte se, da li je to pravilno? Ako je odgovor potvrdan, slijedeće je pitanje, da li se brzo daje pouka? Ako je odgovor da, dokumentacija je dobra.
