Bez ohledu na to, jak geniální může být vynálezce, programátor nebo racionalizátor, jeho výtvory někdy nelze použít k zamýšlenému účelu. Důvodem je nesprávně vypracovaný návod k použití nebo jeho úplná absence. Ale i vynalézaví vynálezci někdy píší takové instrukce, že kromě úzkých odborníků nikdo tyto dokumenty nedokáže přečíst. Jak tedy správně vypracovat takový nezbytný dokument?
Je to nutné
- - stoprocentní znalost zařízení nebo softwarového produktu, pro který je manuál psán;
- - znalosti z oblasti lingvistiky;
- - psací dovednosti.
Instrukce
Krok 1
Uživatelská příručka nebo jinými slovy provozní příručka je dokument, jehož cílem je poskytnout uživatelům pomoc při používání určitého systému. Chcete-li sestavit uživatelskou příručku, potřebujete znát popsaný systém na sto procent, ale dívat se na něj očima neznalého studenta. Předpokládejme, že uživatelská příručka je napsána pro softwarový nástroj, který dosud nemá žádné analogy. Představte si, že používáte tento program poprvé. Kde začínáš? Co je první věc vědět? Uspořádejte tyto znalosti do kategorií důležitosti.
Krok 2
Rozdělením všech informací týkajících se vašeho vytvoření do skupin jste vypracovali plán pro napsání uživatelské příručky. Začněte od začátku popisovat práci ve svém programu a nechejte si poslední nejobtížnější detaily, jako je přeprogramování funkcí nebo řešení kritických chyb. V této fázi byste měli mít připraven obsah uživatelské příručky - jedné z požadovaných částí tohoto dokumentu.
Krok 3
Pokud je manuál, který vytváříte, určen pro použití ve velké společnosti, měli byste věnovat pozornost tam přijatým podnikovým standardům. Například v mnoha ruských společnostech nejsou uživatelské příručky přijímány bez názorné podpory, jinými slovy, obrázků, které vysvětlují, co je napsáno. Kromě obsahu by uživatelská příručka měla obsahovat další povinné části: - Anotace, tj. Vysvětlení obecných cílů příručky a popsaného produktu; - úvod, který popisuje dokumenty související s uživatelskou příručkou a jak používat příručku; - oddíly vysvětlující používání výrobku v různých fázích jeho používání, například první kroky, opravy nebo údržba; - oddíl často kladených otázek a odpovědí na ně; - glosář nebo rejstřík předmětů.
Krok 4
Na vytvoření uživatelské příručky se obvykle podílí technický spisovatel - osoba, která má všechny potřebné znalosti jak v jazyce, tak v popisovaném produktu. Jako technický spisovatel bez školení je třeba mít na paměti několik pravidel. Za prvé nesmíte zneužívat speciální podmínky, které běžný uživatel nechápe. Zadruhé, každý použitý termín musí být podrobně vysvětlen a vysvětlen. Za třetí, musíte psát co nejjasněji a nejstručněji. Nakonec musí být technický spisovatel schopen podívat se na svůj vlastní text očima běžného uživatele, aby viděl nedostatky svého vlastního textu.
Krok 5
Je dobré otestovat hotový text uživatelské příručky v praxi tak, že ji nabídnete osobě, která s popsaným výrobkem nemá nic společného. Společným úsilím je možné odstranit všechny nedostatky a úskalí dokumentu.
