Jos sinusta on annettu tehtäväksi kirjoittaa asiakirja, jonka on tarkoitus opettaa joku muu tekemään jotain, nykypäivän tapa tehdä se heittää vanhat menetelmät enemmän tai vähemmän.
1. Suuret pommitetut otsikot
Huomaat, että PCMechin otsikot, kuten oikea tämän lauseen yläpuolella, ovat valtavat. Tämä johtuu siitä, että he ovat helpompi nähdä, lukea ja tietää missä olet asiakirjassa.
2. Vähemmän sanoja
Väärällä tavalla:
Seuraava asiakirja selittää, kuinka Fanny Whacker 2000 -laitetta käytetään ja käytetään.
Oikea tapa:
Fanny Whacker 2000: n käyttöohjeet
Muista aina tämä lause kirjoittaessasi dokumentaatiota: JATKO PISTEeseen NOPEASTI MAHDOLLISESTI.
3. Ohita turha viitteet
Jos viitteellä ei ole mitään tekemistä sen ydinohjeen kanssa, jota yrität kuvata, kuten:
Lisätietoja Fanny Whacker 2000: n naurisidonnaisesta löytyy asiakirjasta FU, alaosa ID10T.
… älä tee sitä.
4. Päivämäärä. Aina.
Asiakirjan laatimispäivämäärän tulisi olla jokaisen sivun alatunnistealueella. Jos kyseessä on sähköinen asiakirja, päivämäärä näytetään kahdesti. Kerran alussa, kerran lopussa.
Voit kirjoittaa tämän nimellä "Viimeksi muutettu (lisää päivämäärä tähän)".
5. Varoitukset tulee aina lähettää ennen palautuskohtaa
Jos asiakirjoissasi on jotain, joka voi mahdollisesti vahingoittaa / tuhota / hävittää jotain, jos sitä tehdään väärin, nämä tiedot on sijoitettava heti mainitun ohjeen jälkeen, oltava näkyvissä (tarkoittavat samalla sivulla) ja korostettuna.
Esimerkki:
Vaihe 5. Fanny Whacker 2000: n puhdistaminen
FW2000: n melat on puhdistettava varovasti ei-hankaavalla pehmeällä liinalla.
VAROITUS: Käytä vain ammoniakkittomia liuottimia estääksesi FW2000: n räjähtämisen ja johtamatta ennenaikaiseen kuolemaan.
Viimeisenä huomautuksena on, että hyvä dokumentaatio ei ole ylimäärin kuvaavaa kaikista mahdollisista mahdollisista asioista. Lue ohjeet ja kysy itseltäsi, ohjeistaako se oikein? Jos vastaus on kyllä, seuraava kysymys on, opettaako se nopeasti ? Jos kyllä, dokumentaatio on hyvä.
