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

Krok 1

Napište obrys manuálu. To vám dá plán následovat. Body, které mají být do schématu zahrnuty, jsou proces instalace, aplikace programu, popisy nabídek, běžné úkoly, pokročilé funkce a část pro odstraňování problémů. Zahrnuje také podčásti ve vašem návrhu pro konkrétní úkoly, jako je vytváření nového souboru, ukládání a tisk souborů.

Krok 2

Podrobnosti procesu instalace, včetně požadavků na počítač. Poskytuje požadavky před hlavní instalací, takže uživatelé si mohou připravit svůj počítač. Popište i ty nejzákladnější kroky pro počítačové začátečníky. Tyto kroky mohou být „dvojklikem na instalační soubor“ nebo „vložení 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í každou obrazovkou IGU (Grafické uživatelské rozhraní), se kterou je nalezen, zaregistrováním program a zadejte libovolný kód nebo sériová čísla a způsob přístupu k programu po instalaci, abyste ověřili, zda je instalace správná.

Krok 3

Uveďte podrobný popis aplikací programu. Zahrnuje to, co je program potřebný a jak z něj lze získat. Pokud se například program zabývá účetnictvím, vysvětlete, jak usnadňuje běžné účetní úkoly. Objasňuje, jaké jsou nejdůležitější funkce pro koncového uživatele. To uživateli poskytne představu o tom, jaké funkce se bude nejprve snažit naučit. Například v programu pro tvorbu hudby řekněte uživateli, kolik stop může nahrávat najednou, všechny zvuky a rytmy, které má, a v jakých formátech může soubory ukládat. Obsahuje stručný popis pokročilých funkcí, díky kterým je program odlišný od ostatních na trhu. Například váš program může být schopen generovat více sestav nebo podporovat více typů souborů než jakýkoli jiný program, který je v současné době k dispozici.

Krok 4

Vysvětlete, jak procházet nabídky. Vysvětlete každý bod dostupných nabídek. Vše, co nelze vysvětlit jednou nebo dvěma větami, by mělo být uvedeno v části Společné úkoly v příručce. Tyto úkoly mohou zahrnovat změnu písmen a barev, způsob tisku různých formátů a typů souborů a uspořádání souborů a informací.

Krok 5

Napište samostatnou sekci pro pokročilé funkce a další funkce. Zde byste měli jít do podrobností. Uživatelská příručka pro Microsoft Excel by například zahrnovala informace o tom, jak vytvářet sestavy, odkazy a makra. Mezi další funkce patří funkce, které uživatel nemusí očekávat. Například program pro tvorbu hudby by mohl přinést vestavěný hudební přehrávač. Udělejte si čas a vysvětlete jakékoli další doplňky, které přicházejí s programem, nebo jeho jedinečné aplikace.

Krok 6

Obsahuje návrhy na řešení problémů. Vysvětlete význam každé chyby, kterou může uživatel najít, jak problém vyřešit a jak mu v budoucnu zabránit. To je také místo, kde byste měli uvést kontaktní informace a informace o zákaznických službách.

Zajímavé Články