Jak napsat uživatelskou příručku k programu

Krok 1

Napište schéma manuálu. To vám dá plán, který budete následovat. Body, které se do schématu zapojí, by byly proces instalace, aplikace programu, popisy nabídek, běžné úlohy, pokročilé funkce a část pro odstraňování problémů. Obsahuje také pododdíly vašeho návrhu pro konkrétní úkoly, jako je vytvoření nového souboru, ukládání a tisk souborů.

Krok 2

Podrobně popisuje proces instalace včetně požadavků na počítač. Poskytuje požadavky před hlavní instalací, takže uživatelé mohou připravit svůj počítač. Popisuje i nejzákladnější kroky pro začínající počítače. Tyto kroky mohou být "dvojitým kliknutím na instalační soubor" nebo "vložit disk CD do jednotky CD ROM". Typické kroky instalace zahrnují vysvětlení možností instalace, jako je typická instalace na rozdíl od pokročilé instalace, přičemž uživatel krok za krokem prochází obrazovkou IGU (Grafické uživatelské rozhraní), se kterým je umístěna, a zaznamenává program a zadejte libovolné kódové nebo sériové číslo a jak přistupovat k programu po instalaci, abyste ověřili správnost instalace.

Krok 3

Proveďte podrobný popis aplikací programu. Obsahuje, proč je program zapotřebí a jak můžete získat užitek z něj. Například pokud se program zabývá účetnictvím, vysvětluje, jak jednodušší provádět běžné účetní úkony. Objasňuje, které jsou pro koncového uživatele nejdůležitější funkce. To uživateli poskytne představu o tom, jaké funkce se bude nejprve snažit. Například v programu pro hudební tvorbu informujte uživatele o tom, kolik stop může nahrát najednou, všechny zvuky a rytmy, které má, a v jakých formátech dokáže soubory uložit. Obsahuje stručný popis pokročilých funkcí, které z něj činí jiný program než ostatní na trhu. Například váš program může být schopen generovat více zpráv nebo podporovat více typů souborů než kterýkoli jiný program, který je v současné době k dispozici.

Krok 4

Vysvětluje, jak se pohybovat v nabídkách. Vysvětlete každý bod dostupných nabídek. Veškeré informace, které nelze vysvětlit v jedné nebo dvou větech, by měly být zahrnuty do části Společné úkoly v příručce. Tyto úkoly mohou zahrnovat změnu písma a barev, způsobu tisku různých formátů a typů souborů a uspořádání souborů a informací.

Krok 5

Napište samostatný oddíl pro pokročilé funkce a další funkce. Zde se musíte dostat do detailů. Uživatelská příručka pro aplikaci Microsoft Excel například obsahuje informace o tom, jak vytvářet přehledy, odkazy a makra. Další funkce zahrnují funkce, které uživatel nemusí čekat. Program pro vytváření hudby by například mohl přinést vestavěný hudební přehrávač. Udělejte si čas na vysvětlení jakýchkoli dalších informací, které přicházejí s vaším programem, nebo jeho jedinečných aplikací.

Krok 6

Zahrnuje návrhy na řešení problémů. Vysvětluje význam každé chyby, kterou může uživatel najít, jak problém vyřešit a jak tomu zabránit v budoucnu. Toto je také místo, kde byste měli zahrnout kontaktní informace a informace o zákaznících.