Kad ir koks išradingas, programuotojas ar racionalizatorius būtų išradingas, kartais jo kūryba paprasčiausiai negali būti naudojama pagal paskirtį. To priežastis yra neteisingai parengtas naudojimo vadovas arba visiškas jo nebuvimas. Tačiau net išradingi išradėjai kartais parašo tokias instrukcijas, kad, išskyrus siaurus specialistus, niekas negali skaityti šių dokumentų. Taigi, kaip tinkamai surašyti tokį reikalingą dokumentą?
Tai būtina
- - šimtas procentų žinių apie įrenginį ar programinės įrangos produktą, kuriam rašomas vadovas;
- - žinios kalbotyros srityje;
- - rašymo įgudžiai.
Nurodymai
1 žingsnis
Vartotojo vadovas arba, kitaip tariant, naudojimo vadovas yra dokumentas, sukurtas padėti vartotojams naudotis tam tikra sistema. Norėdami sudaryti vartotojo vadovą, turite šimtą procentų žinoti aprašytą sistemą, tačiau pažvelkite į tai nemokšo studento akimis. Tarkime, yra parašytas programinės įrangos, kuri dar neturi analogų, vartotojo vadovas. Įsivaizduokite, kad pirmą kartą naudojatės šia programa. Nuo ko pradėti? Ką pirmiausia reikia žinoti? Organizuokite šias žinias į svarbos kategorijas.
2 žingsnis
Suskirstę visą informaciją apie savo kūrybą į grupes, jūs parengėte vartotojo vadovo rašymo planą. Pradėkite aprašyti darbą savo programoje nuo nulio, palikdami paskutines pačias sunkiausias detales, tokias kaip perprogramavimo funkcijos ar kritinių klaidų sprendimas. Šiame etape turėtumėte paruošti vartotojo vadovo turinį - vieną iš būtinų šio dokumento dalių.
3 žingsnis
Jei jūsų kuriamas vadovas yra skirtas naudoti didelėje įmonėje, turėtumėte atkreipti dėmesį į ten priimtus įmonių standartus. Pavyzdžiui, daugelyje Rusijos bendrovių vartotojo vadovai nepriimami be iliustratyvios paramos, kitaip tariant, paveikslėlių, paaiškinančių tai, kas parašyta. Be turinio, vartotojo vadove turėtų būti kitos privalomos dalys: - anotacija, tai yra paaiškinimai apie bendruosius vadovo tikslus ir aprašytą gaminį; - įvadas, kuriame aprašomi su vartotojo vadovu susiję dokumentai ir kaip naudoti skyrių, paaiškinantį produkto naudojimą įvairiais jo naudojimo etapais, pvz., pirmuosius žingsnius, taisymą ar priežiūrą, - skyrių, kuriame dažnai užduodami klausimai ir atsakymai į juos, - žodyną ar temų rodyklę.
4 žingsnis
Paprastai kuriant vartotojo vadovą dalyvauja technikos rašytojas - asmuo, turintis visas reikalingas žinias tiek kalba, tiek aprašomu produktu. Kaip technikos rašytojas be išsilavinimo, turėtumėte nepamiršti kelių taisyklių. Pirma, neturite piktnaudžiauti specialiomis sąlygomis, kurios nesuprantamos paprastam vartotojui. Antra, kiekvienas vartojamas terminas turi būti išsamus ir paaiškintas. Trečia, reikia rašyti kuo aiškiau ir glaustiau. Galiausiai technikos rašytojas turi sugebėti pažvelgti į savo tekstą paprasto vartotojo akimis, kad pamatytų savo paties teksto trūkumus.
5 žingsnis
Gera praktiškai išbandyti gatavą vartotojo vadovo tekstą, siūlydamas jį asmeniui, neturėjusiam nieko bendro su aprašytu produktu. Bendromis pastangomis įmanoma pašalinti visus dokumento trūkumus ir trūkumus.
