Obsah
Návody k použití jsou vynikající aplikací v oblasti technického psaní. Dobrý návod k obsluze bude uživateli říkat vše, co musí udělat, aby mohl daný úkol efektivně a bezpečně sledovat.
Pokyny
-
Identifikujte lidi, kterým bude úkol přidělen, a napište si o jejich úrovni porozumění. Znalost cílové skupiny je klíčovou součástí techniky psaní.
-
Pokud bude obsahovat více než několik stránek, napište na přední část příručky souhrn. Pokud je příručka příliš dlouhá, uveďte na zadní straně index.
-
Napište stručný úvod, který popisuje úkol z kvalitativního hlediska. Dejte uživateli představu o úkolu a jaký bude konečný výsledek. Tato příležitost by měla sloužit k poskytování důležitých rad, které pomohou uživateli pracovat správně a efektivně.
-
V případě potřeby uveďte seznam příslušných zařízení a položek, které bude uživatel potřebovat k dokončení úkolu. Pokud je návod k použití určen k montáži výrobku a přiložen k výrobku, který má být smontován, uveďte samostatný seznam všech dílů, které měly být uživateli dodány.
-
Jasně uveďte jakékoli významné riziko, které by mohlo způsobit zranění, smrt, škody na majetku a jiná nebezpečí. Používejte odpovídající jazyk se zákony místa, kde bude manuál prodáván.
-
Každou akci výpisu napište do samostatného kroku a poskytněte všechny informace, které bude uživatel potřebovat k dokončení tohoto kroku. Psaní musí být doslovné, přímo k věci a nemůže být dvojznačné.
-
Pokud je v příručce místo, uveďte obrázky a schémata pokaždé, když pro uživatele zrušíte obtížný krok.
-
Je-li to nutné, vytvořte a zahrňte seznam doporučení, který uživatele provede k dokončení úkolu.