Ak ste dostali za úlohu napísať dokument, ktorý má poučiť niekoho iného o tom, ako niečo urobiť, dnešný spôsob, ako to urobiť, vyhodí staré metódy z okna.
1. Veľké bombastické hlavičky
Všimnite si, že hlavičky na PCMech, ako sú tie, ktoré sa nachádzajú nad touto vetou, sú obrovské. Je to preto, že sa v dokumente ľahšie dajú prečítať, prečítať a vedieť, kde sa nachádzate.
2. Menej slov
Zlým smerom:
Nasledujúca dokumentácia vysvetľuje, ako používať a prevádzkovať Fanny Whacker 2000.
Správna cesta:
Pokyny na používanie Fanny Whacker 2000
Pri písaní dokumentácie si túto frázu vždy pamätajte: ZÍSKAJTE BODY AKO RÝCHLE AKO MOŽNÉ.
3. Preskočte zbytočné referencie
Ak referencia nemá nič spoločné s hlavnou inštrukciou toho, čo sa snažíte opísať, ako napríklad:
Ďalšie informácie o Turnad Twaddler od Fanny Whacker 2000 nájdete v dokumente FU, pododdiel ID10T.
… nerob to.
4. Dátum. Always.
Dátum, kedy bola dokumentácia napísaná, by mal byť v päte každej strany. Ak ide o elektronický dokument, dátum sa zobrazí dvakrát. Raz na začiatku, raz na konci.
Môžete to napísať ako „Naposledy upravené (tu zadajte dátum)“.
5. Výstrahy by mali byť vždy zverejnené pred dňom, keď sa nevrátia
Ak sa vo vašej dokumentácii nachádza niečo, čo by mohlo poškodiť / zničiť / zničiť niečo nesprávne, mali by ste tieto informácie umiestniť bezprostredne po uvedenej inštrukcii, mali by byť na dohľad (čo znamená na tej istej stránke) a mali by sa zvýrazniť.
Príklad:
Krok 5. Čistenie Fanny Whacker 2000
Pádla FW2000 by sa mali čistiť jemne pomocou neabrazívnej mäkkej handričky.
VAROVANIE: Používajte iba rozpúšťadlo neobsahujúce amoniak, aby ste zabránili výbuchu FW2000 a neviedli k predčasnej smrti.
Záverom je, že dobrá dokumentácia nie je príliš popisná o každej možnej veci, ktorú si možno predstaviť. Prečítajte si svoju dokumentáciu a opýtajte sa sami seba, dá to správne pokyny? Ak je odpoveď áno, je ďalšia otázka, dá pokyn rýchlo ? Ak áno, dokumentácia je dobrá.
