Bez ohľadu na to, aký geniálny je vynálezca, programátor alebo racionalizátor, niekedy jeho výtvory jednoducho nemožno použiť na zamýšľaný účel. Dôvodom je nesprávne zostavený návod na obsluhu alebo jeho úplná absencia. Ale aj geniálni vynálezcovia niekedy píšu také pokyny, že okrem úzkych špecialistov nemôže nikto tieto dokumenty čítať. Ako teda správne vypracovať taký potrebný dokument?
Je to nevyhnutné
- - stopercentné znalosti o zariadení alebo softvérovom produkte, pre ktorý sa príručka píše;
- - vedomosti z oblasti lingvistiky;
- - písacie schopnosti.
Inštrukcie
Krok 1
Používateľská príručka alebo inými slovami prevádzková príručka je dokument určený na poskytovanie pomoci používateľom pri používaní určitého systému. Na zostavenie používateľskej príručky musíte poznať opísaný systém na sto percent, ale pozerať sa na ňu očami neznalého študenta. Predpokladajme, že používateľská príručka je napísaná pre softvérový nástroj, ktorý ešte nemá analógy. Predstavte si, že tento program využívate prvýkrát. Kde začínate Čo je prvé, čo treba vedieť? Usporiadajte tieto vedomosti do dôležitých kategórií.
Krok 2
Rozdelením všetkých informácií týkajúcich sa vášho vytvorenia do skupín ste vytvorili plán na napísanie používateľskej príručky. Začnite od začiatku opisovať prácu vo svojom programe a nechajte si posledné najťažšie podrobnosti, ako napríklad preprogramovanie funkcií alebo riešenie kritických chýb. V tejto fáze by ste mali mať pripravený obsah používateľskej príručky - jednej z povinných častí tohto dokumentu.
Krok 3
Ak je príručka, ktorú vytvárate, určená na použitie vo veľkej spoločnosti, mali by ste venovať pozornosť podnikovým štandardom tam prijatým. Napríklad v mnohých ruských spoločnostiach nie sú užívateľské príručky akceptované bez ilustračnej podpory, inými slovami, obrázkov, ktoré vysvetľujú, čo je napísané. Používateľská príručka by okrem obsahu mala obsahovať aj ďalšie povinné časti: - Anotáciu, to znamená vysvetlenie všeobecných cieľov príručky a opísaného produktu, - úvod, ktorý popisuje dokumenty súvisiace s používateľskou príručkou a ako používať príručku; - časti vysvetľujúce používanie produktu v rôznych fázach jeho používania, napríklad prvé kroky, opravy alebo údržba; - časť často kladených otázok a odpovedí na ne; - slovník alebo zoznam predmetov.
Krok 4
Na tvorbe užívateľskej príručky sa zvyčajne podieľa technický spisovateľ - osoba, ktorá má všetky potrebné znalosti tak v jazyku, ako aj v popisovanom produkte. Ako technický spisovateľ bez odbornej prípravy musíte mať na pamäti niekoľko pravidiel. Po prvé, nesmiete zneužívať špeciálne podmienky, ktoré bežný používateľ nedokáže pochopiť. Po druhé, každý použitý výraz musí byť podrobný a vysvetlený. Po tretie, musíte písať čo najjasnejšie a najvýstižnejšie. Napokon musí byť technický pracovník schopný pozerať sa na svoj vlastný text očami bežného používateľa, aby zistil nedostatky svojho vlastného textu.
Krok 5
Je dobré otestovať hotový text používateľskej príručky v praxi tak, že ju ponúknete osobe, ktorá s opísaným produktom nemala nič spoločné. Spoločným úsilím je možné odstrániť všetky nedostatky a úskalia dokumentu.
