Jei jums buvo pavesta parašyti dokumentą, kuris turėtų išmokyti ką nors kitą, kaip tai padaryti, šiandieninis būdas tai padaryti daugiau ar mažiau išmeta senus metodus.
1. Didelės bombarduojamos antraštės
Pamatysite, kad „PCMech“ antraštės, tokios, kurios yra tiesiai virš šio sakinio, yra didžiulės. Taip yra todėl, kad juos lengviau pamatyti, skaityti ir žinoti, kur esate dokumente.
2. Mažiau žodžių
Neteisingas būdas:
Tolesnė dokumentacija paaiškina, kaip naudoti ir naudoti „Fanny Whacker 2000“.
Tinkamas būdas:
„Fanny Whacker 2000“ naudojimo instrukcijos
Rašydami dokumentus, visada atsiminkite šią frazę: UŽSAKYKITE PUNKTĄ, KAD GALIMA.
3. Praleiskite nenaudingas nuorodas
Jei nuoroda neturi nieko bendra su pagrindinėmis instrukcijomis, kurias bandote apibūdinti, pavyzdžiui:
Norėdami gauti daugiau informacijos apie „Fanny Whacker 2000“ ropių vijoklį, skaitykite dokumento FU, ID10T poskyrį.
… nedaryk to.
4. Data. Visada.
Kiekvieno puslapio poraštės srityje turėtų būti dokumento parašymo data. Jei tai yra elektroninis dokumentas, data parodoma du kartus. Kartą pradžioje, vieną kartą pabaigoje.
Tai galite parašyti kaip „Paskutinį kartą peržiūrėta (įrašyti datą čia)“.
5. Įspėjimai visada turėtų būti skelbiami prieš negrįžtant
Jei jūsų dokumentuose yra kažkas, kas netinkamai atlikus, gali ką nors sugadinti / sunaikinti / sunaikinti, ši informacija turėtų būti dedama iškart po minėtos instrukcijos, būti aiškiai matoma (reiškia tame pačiame puslapyje) ir pabrėžti.
Pavyzdys:
5 žingsnis. „Fanny Whacker 2000“ valymas
„FW2000“ irklus reikia švelniai valyti nenuvaloma minkšta šluoste.
ĮSPĖJIMAS: Naudokite tik tirpiklį be amoniako, kad FW2000 nesprogtų ir nesukeltumėte savo mirties.
Galiausiai pažymėtina, kad gera dokumentacija nėra tokia, kad apibūdintų kiekvieną įmanomą dalyką. Perskaitykite savo dokumentaciją ir paklauskite savęs, ar ji tinkamai moko? Jei atsakymas yra teigiamas, kitas klausimas yra, ar jis nurodo greitai ? Jei taip, dokumentai yra geri.
