Olulise tööülesannete käsiraamatu kirjutamine võib näidata teie võimeid ülemustele. See näitab teie võimet projekt ise lõpule viia.
1
Otsustage oma teema üle. Olge ulatuse ja ulatuse osas konkreetne.
2
Otsustage, millisele publikule kirjutate. Kas kirjutate käsiraamatut algajatele või asjatundjatele (või kuhugi vahepeale)?Kas publik kaasatakse klassi (kasutades käsiraamatut) või iseõppimisse?
3
Määrake juhendis täpselt, millest te räägite.Näide: Kirjutate käsiraamatut “Kuidas paigaldada uksi”. Üks jaotis võib olla lükanduste kohta. Teine osa võib olla välisuste kohta. Veel üks osa võib olla tagauste kohta.
4
Otsustage oma käsiraamatu esitamiseks loogiline järjekord. See ei puuduta tegevuste loogilist järjestust. Mõnda teemat võib olla vaja esmalt esitada. Tõenäoliselt tuleks kõigepealt arutada ülesandeid, mis sisalduvad käsiraamatu kõigis osades. Kui tunned, et lugejal peaksid ülesande täitmiseks oskused juba olemas olema, siis kaalu ülesande kirjeldamist lisas.
5
Kui käsiraamatus kasutatakse tehnilist terminoloogiat või žargooni, koostage sõnastik. Kui on ebatõenäoline, et lugeja žargooni juba teab, asetage sõnastik kohe sisukorra järele. Käsiraamatut kirjutades värskendage sõnastikku. Sõnastikus sisalduvad mõistete definitsioonid peavad olema võimalikult täpsed. Kui termin on akronüüm, näiteks “Scuba”, siis selgitage täielikult, et see tähendab definitsioonis “iseseisvat veealust hingamisaparaati”.
6
Otsustage, milliseid teemasid peate täiendavalt uurima. Ebatäpne juhend on kasutu käsiraamat. Enne juhendi käivitamist viige läbi esialgne uurimine.
7
Otsustage iga kirjutatava jaotise organisatsioon.Näide: kirjutate sellise arvuti käsiraamatu. Teil on jaotis “Veaotsing”. Võite kirjutada osa sellest kettaruumi probleemide kohta. Võite kirjutada veel ühe liigse mälukasutuse kohta.
8
Korraldage iga jaotis ja alajaotis loogilises järjekorras, ahendades teema ulatust.
9
Alusta kirjutamist! Kasutage oma organisatsiooni juhendina, kuid muutke seda, kui see ei tööta.Kirjutage erinevate ülesannete kirjeldused.Kirjutage näiteid, mida lugeja saab juhiste saamiseks järgida. Valmistage ette sobivad illustratsioonid. Ärge lisage neid enne, kui juhend on valmis. Illustratsioonid tuleb tekstile sobitada.Muutke illustratsioone, et anda vihjeid, et näidata, mida kasutaja otsib.Näide 1: (Nummerdatud loendist vaatamine) Kirjanik ühendaks probleemi numbriga “13”.Näide 2 : (Välja sortimine) Kirjanik suurendas tekstirida, mis oli korrast ära.
10
Ärge plagieerige kellegi teise kirjutist! Lisage viide ja/või tsitaatide jaotis, kus on loetletud raamatud, käsiraamatud ja inimesed, kes teile teavet andsid. Miski ei hävita kirjaniku usaldusväärsust kiiremini kui plagiaat. Ühel päeval võib keegi teie kirjutist tsiteerida. Kuidas suhtuksite sellesse, kui keegi teie töö “varastab”?
11
Lisage sobivad illustratsioonid. Paigaldage need dokumenti. Ärge kartke kasutada tühikuid.
12
Korrektuur, korrektuur ja veelkord korrektuur. Korrektuur peaks jätkuma. Märkige üles vead või puudused. Parandage need. Märkige üles lõigud, mida teised segadust tekitavad. Kirjutage lõik ümber, et seda oleks lihtsam lugeda. Laske paljudel inimestel teie käsiraamatut lugeda, et tagada parim võimalik tulemus.Selles järjekorras soovitan teil käsitsi korrektuuri läbi lugeda:Tõestage oma tööd ise.Paluge sõbral seda korrektuuri lugeda.Paluge asjatundjal (alal, mida kirjutate umbes) lugege seda korrektuuri.(Kui juhend on teie ettevõtte jaoks), laske oma ülemusel seda korrektuuri lugeda. Laske see algajal korrektuuril.Miks lasta seda algajal korrektuuri lugeda? Kasutusjuhend peab olema arusaadav minimaalse teadmiste tasemeni, mille lugemiseks eeldate.