Ükskõik kui geniaalne leiutaja, programmeerija või ratsionaliseerija ka poleks, ei saa tema loomingut mõnikord lihtsalt ettenähtud otstarbel kasutada. Selle põhjuseks on valesti koostatud kasutusjuhend või selle täielik puudumine. Kuid isegi leidlikud leiutajad kirjutavad mõnikord sellised juhised, et peale kitsaste spetsialistide ei saa keegi neid pabereid lugeda. Kuidas siis nii vajalik dokument õigesti vormistada?
See on vajalik
- - sajaprotsendiline teadmine seadme või tarkvaratoote kohta, mille kohta käsiraamat koostatakse;
- - teadmised keeleteaduse alal;
- - kirjutamisoskused.
Juhised
Samm 1
Kasutusjuhend või, teisisõnu, kasutusjuhend on dokument, mille eesmärk on pakkuda kasutajatele abi teatud süsteemi kasutamisel. Kasutusjuhendi koostamiseks peate kirjeldatud süsteemi tundma sada protsenti, kuid vaatama seda asjatundmatu õpilase pilgu läbi. Oletame, et tarkvara utiliidi jaoks, millel pole veel analooge, on kirjutatud kasutusjuhend. Kujutage ette, et kasutate seda programmi esimest korda. Kust sa alustad? Mida peaks kõigepealt teadma? Korrastage need teadmised tähtsuse kategooriatesse.
2. samm
Jagades kogu oma loomingut puudutava teabe rühmadesse, olete koostanud kasutusjuhendi kirjutamise plaani. Alustage oma töö kirjeldamist nullist, jättes viimaseks kõige keerulisemad detailid, näiteks funktsioonide ümberprogrammeerimise või kriitiliste vigadega tegelemise. Selles etapis peaksite olema valmis kasutusjuhendi sisu - üks selle dokumendi nõutavatest osadest.
3. samm
Kui teie loodud käsiraamat on mõeldud kasutamiseks suures ettevõttes, peaksite pöörama tähelepanu seal vastuvõetud ettevõtte standarditele. Näiteks paljudes Venemaa ettevõtetes ei aktsepteerita kasutusjuhendeid ilma illustratiivse toeta, teisisõnu pilte, mis selgitavad kirjutatut. Lisaks sisule peaks kasutusjuhend sisaldama muid kohustuslikke osi: - märkus, see tähendab kasutusjuhendi ja kirjeldatud toote üldiste eesmärkide selgitus; - sissejuhatus, milles kirjeldatakse kasutusjuhendiga seotud dokumente ja kuidas käsiraamatu kasutamine; - jaotised, mis selgitavad toote kasutamist selle erinevates kasutamisetappides, näiteks esimeste sammude, remondi või hoolduse korral; - jaotis korduma kippuvate küsimuste ja neile vastuste kohta; - sõnastik või teemaindeks.
4. samm
Tavaliselt on kasutusjuhendi loomisega seotud tehniline kirjutaja - inimene, kellel on olemas kõik vajalikud teadmised nii keeles kui ka kirjeldatavas tootes. Koolituseta tehnikakirjanikuna tuleb silmas pidada mõnda reeglit. Esiteks ei tohi te kuritarvitada eritingimusi, mis pole tavakasutajale arusaadavad. Teiseks peavad kõik kasutatavad mõisted olema üksikasjalikud ja selgitatud. Kolmandaks peate kirjutama võimalikult selgelt ja lühidalt. Lõpuks peab tehniline kirjutaja suutma oma teksti puuduste nägemiseks oma teksti tavakasutaja pilgu läbi vaadata.
5. samm
Kasutusjuhendi valmis teksti on hea praktikas testida, pakkudes seda inimesele, kellel polnud kirjeldatud tootega midagi pistmist. Ühiste jõupingutustega on võimalik kõrvaldada kõik dokumendi puudused ja lõkse.
