Lai cik atjautīgs būtu izgudrotājs, programmētājs vai racionalizētājs, dažreiz viņa radīto vienkārši nevar izmantot paredzētajam mērķim. Iemesls tam ir nepareizi sastādīta lietošanas instrukcija vai tās pilnīga neesamība. Bet pat atjautīgi izgudrotāji dažreiz raksta tādas instrukcijas, ka, izņemot šaurus speciālistus, neviens nevar lasīt šos dokumentus. Tātad, kā jūs pareizi noformējat tik nepieciešamo dokumentu?
Tas ir nepieciešams
- - simtprocentīgas zināšanas par ierīci vai programmatūras produktu, par kuru tiek rakstīta rokasgrāmata;
- - zināšanas valodniecības jomā;
- - rakstīt prasme.
Instrukcijas
1. solis
Lietotāja rokasgrāmata vai, citiem vārdiem sakot, darbības rokasgrāmata ir dokuments, kas izstrādāts, lai sniegtu palīdzību lietotājiem izmantot noteiktu sistēmu. Lai sastādītu lietotāja rokasgrāmatu, simtprocentīgi jāzina aprakstītā sistēma, bet jāskatās uz to nezinoša studenta acīm. Pieņemsim, ka programmatūras utilītai, kurai vēl nav analogu, ir rakstīta lietotāja rokasgrāmata. Iedomājieties, ka jūs pirmo reizi izmantojat šo programmu. Ar ko sākt? Kas ir pirmais, kas jāzina? Organizējiet šīs zināšanas svarīguma kategorijās.
2. solis
Sadalot visu informāciju par savu radīšanu grupās, jūs esat sastādījis lietotāja rokasgrāmatas sastādīšanas plānu. Sāciet aprakstīt darbu savā programmā no jauna, atstājot visgrūtākās detaļas, piemēram, funkciju pārprogrammēšanu vai problēmu risināšanu ar kritiskām kļūdām. Šajā posmā jums vajadzētu būt gatavam lietotāja rokasgrāmatas saturam - vienai no nepieciešamajām šī dokumenta daļām.
3. solis
Ja jūsu izveidotā rokasgrāmata ir paredzēta lietošanai lielā uzņēmumā, jums vajadzētu pievērst uzmanību tur pieņemtajiem korporatīvajiem standartiem. Piemēram, daudzos Krievijas uzņēmumos lietotāja rokasgrāmatas netiek pieņemtas bez ilustratīva atbalsta, citiem vārdiem sakot, attēliem, kas izskaidro rakstīto. Papildus saturam lietotāja rokasgrāmatā jāiekļauj arī citas obligātās daļas: - anotācija, tas ir, rokasgrāmatas un aprakstītā produkta vispārīgo mērķu skaidrojums; - ievads, kurā aprakstīti ar lietotāja rokasgrāmatu saistītie dokumenti un kā - izmantot rokasgrāmatu; - sadaļas, kurās paskaidrota produkta lietošana dažādos tā lietošanas posmos, piemēram, pirmie soļi, remonts vai apkope; - sadaļa ar bieži uzdotajiem jautājumiem un atbildēm uz tiem;
4. solis
Parasti lietotāja rokasgrāmatas izveidē ir iesaistīts tehniskais autors - persona, kurai ir visas nepieciešamās zināšanas gan valodā, gan aprakstāmajā produktā. Kā tehniskais rakstnieks bez apmācības jāņem vērā daži noteikumi. Pirmkārt, jūs nedrīkstat ļaunprātīgi izmantot īpašus vārdus, kas nav saprotami parastam lietotājam. Otrkārt, katram lietotajam terminam jābūt detalizētam un paskaidrotam. Treškārt, jums ir jāraksta pēc iespējas skaidrāk un kodolīgāk. Visbeidzot, tehniskajam rakstniekam jāspēj paskatīties uz savu tekstu parastā lietotāja acīm, lai redzētu sava teksta trūkumus.
5. solis
Lietotāja rokasgrāmatas gatavo tekstu ir labi pārbaudīt praksē, piedāvājot to personai, kurai nebija nekāda sakara ar aprakstīto produktu. Kopīgiem spēkiem ir iespējams novērst visus dokumenta trūkumus un trūkumus.
