Jak napsat příručku postupu

Obsah:

Anonim

Postup je jako recept - soubor pokynů, který jasně říká, kdo dělá něco, kdy by mělo být provedeno, jak se to dělá a jaký by měl být výsledek. Uveďte jednotlivé kroky v pořadí, které musí být dokončeno. Zkompilujte několik procedur v příručce, která je uspořádána podle popisu práce, oddělení, funkce nebo podle toho, která objednávka činí informace, které jsou uživatelům manuálu nejvíce přístupné. Nezaměňujte zásady s postupy. Politiky jsou pravidla nebo stanoviska; postupy, které lidé dodržují při provádění politik.

Položky, které budete potřebovat

  • Existující dokumentace, která může být zdrojem materiálu

  • Předmět odborníci, kteří vědí, jak provádět postupy

Rozhodněte, které postupy chcete dokumentovat. Dvě způsoby výběru obsahu manuálu jsou průzkum potenciálními manuálními uživateli, kteří zjistí, na které úkoly potřebují vyjasněnou nebo více informací, nebo můžete upřednostnit seznam provozních problémů, které byste mohli vyřešit pomocí jasně definovaných postupů.

Sbírat informace. Osoba, která již dělá úkol, je vaším nejlepším zdrojem, pokud nevytváříte postupy od začátku. Sledujte, zda osoba vykonává úkol a dělá poznámky, nebo požádejte osobu, aby vám zapsala všechny kroky, které se na daném úkolu podílely, stejně jako všechny tipy nebo varování, které se naučíte ze zkušeností.

Zajistěte rozložení manuálu. Formát s dvěma sloupci umožňuje jasné a snadno čitelné postupy. Označte každou stránku názvem procedury a umístěte pod nadpisem seznam nebo odstavce o skutečnostech, které nespadají do kroku, například o tom, jak často se provádí postup a tipy nebo varování. Postup by měl následovat v tabulce se dvěma sloupci.

Napište hrubý tah. V levém sloupci zadejte osobu odpovědnou za postup. V pravém sloupci zadejte seznam kroků, které daná osoba provádí. Pokud se jedná o proceduru zahrnující více lidí, měli by být všichni schopni jasně vidět, kde se hodí do procesu a co potřebují.

Otestujte postupy. Získejte někoho neznámého s postupy, jak je sledovat z návrhu. Je důležité používat někoho nezkušeného, ​​takže osoba nebude mít žádné obvyklé zkratky nebo lesk na nejasné body, které by jiný čtenář nechápal.

Přezkoumejte návrh. Upravte, přidáváte, odstraňujte a uspořádejte kroky, dokud nebude možné postupovat následovně každým, kdo si přečte příručku.

Publikujte příručku. Zahrňte obsah tak, aby čtenáři mohli rychle najít postupy. Přidejte glosář definující jakoukoli terminologii, která je neobvyklá nebo specifická pro vaše odvětví.

Tipy

  • Nepoužívejte elegantní variantu slov, abyste oživili psaní. "Widget" je widget pokaždé, ne "položka" nebo "zařízení". Opakované popisování věcí může být opakující, ale zlepšuje čtenáři jasnost.