Postup je ako recept - súbor pokynov, ktoré jasne uvádzajú, kto niečo robí, kedy má byť urobené, ako sa to robí a aký by mal byť výsledok. Uveďte každý krok v poradí, v ktorom sa musí vykonať. Zostavte viac procedúr v príručke, ktorá je usporiadaná podľa popisu práce, oddelenia, funkcie alebo podľa toho, ktorá objednávka sprístupňuje informácie pre používateľov manuálu. Nezamieňajte zásady s postupmi. Politiky sú pravidlá alebo stanoviská; postupy, ktoré ľudia sledujú pri vykonávaní politík.
Položky, ktoré budete potrebovať
-
Existujúca dokumentácia, ktorá môže byť zdrojom materiálu
-
Predmet odborníci, ktorí vedia, ako vykonávať postupy
Rozhodnite sa, ktoré postupy chcete dokumentovať. Dva spôsoby výberu vášho manuálneho obsahu spočívajú v zisťovaní potenciálnych manuálnych používateľov, aby ste zistili, na ktoré úlohy potrebujú objasnené alebo viac informácií, alebo môžete uprednostniť zoznam prevádzkových problémov, ktoré by ste mohli vyriešiť pomocou jasne definovaných postupov.
Získať informácie. Človek, ktorý už robí túto úlohu, je váš najlepší zdroj, pokiaľ nevytvárate postupy od začiatku. Pozrite sa, či osoba vykoná úlohu a urobí si poznámky, alebo požiada osobu, aby vám napísala všetky kroky, ktoré sa na tejto úlohe zúčastnili, rovnako ako akékoľvek tipy alebo upozornenia naučené prostredníctvom skúseností.
Zostavte si rozloženie manuálu. Formát s dvoma stĺpcami umožňuje jasné a ľahko čitateľné postupy. Označte každú stránku názvom procedúry a umiestnite pod názov zoznam alebo odsek o akýchkoľvek skutočnostiach, ktoré nespadajú do kroku, ako napríklad o tom, ako často sa postupuje a tipy a varovania. Postup by mal nasledovať potom v tabuľke s dvoma stĺpcami.
Napíšte hrubý koncept. V ľavom stĺpci uveďte osobu zodpovednú za postup. V pravom stĺpci uveďte zoznam krokov, ktoré daná osoba vykoná. Ak sa postup týka viacerých ľudí, mali by byť všetci schopní jasne vidieť, kde sa hodia do procesu a čo potrebujú.
Otestujte postupy. Získajte niekoho, kto nie je oboznámený s postupmi, aby ste ich mohli sledovať z návrhu. Je dôležité používať niekoho neskúseného, takže osoba nebude robiť žiadne obvyklé skratky alebo lesk na nejasné body, ktoré by iný čitateľ nerozumel.
Revidujte návrh. Objasniť, pridať, odstrániť a zmeniť usporiadanie krokov, až kým postup nebude nasledovať každý, kto si prečíta manuál.
Publikujte príručku. Zahrňte obsah, aby čitatelia mohli rýchlo vyhľadať postupy. Pridajte glosár definujúci akúkoľvek terminológiu, ktorá je nezvyčajná alebo špecifická pre váš priemysel.
Tipy
-
Nepoužívajte elegantné variácie slov, aby ste oživili písanie. "Widget" je widget zakaždým, nie "položka" alebo "zariadenie". Opisovanie vecí sa môže opakovať opakovane, ale zlepšuje čitateľnosť pre čitateľov.
