Jak napsat skvělou uživatelskou příručku pro téměř všechno

Obsah:

Anonim

Kdysi dávno, pevné uživatelské příručky doprovázejí nové produkty všeho druhu a poskytují rozsáhlé pokyny, jak se naučit všechny funkce a maximalizovat vaše využití. V dnešní době jsou však uživatelské příručky dodávané ve výrobním závodě mnohem zřetelnější a často ve více jazycích, což komplikuje vaši křivku učení. Chcete-li mít slušnou příručku pro uživatele, je cenná komodita a pokud víte, jak napsat jednu, je to velký talent. Jedná se pouze o zvládnutí několika klíčových zásad.

Položky, které budete potřebovat

  • Program Microsoft Word nebo jiný program pro zpracování textu

  • Sbírka klipartů nebo digitálních fotografií

  • Jednoduchý software pro tvorbu webových stránek

Rozhodněte se pro formát, ať už tištěné dokumenty, webové stránky, e-maily nebo nějakou kombinaci. Jakmile píšete v jednom formátu, je snadné ho přenést do jiného. Někteří lidé jsou pohodlnější číst tištěný dokument, který mohou držet a odložit. Ostatní mohou preferovat URL nebo odkaz na dokument na vašem webu.

Být organizován, jasný a stručný. Předvídat a vysvětlit nejen to, co uživatelé produktů udělají, ale i to, co nemají dělat. Musíte psát s očima k oběma.

Začněte na začátku a rozvíjejte logicky jen potřebné informace. Napište aktivní hlas, ne pasivní. Udržujte kopii nakloněnou a odstraňte cizí slova. Udržujte je jednoduché a metodické.

Rozdělit text s fotografiemi, obrázky nebo diagramy co nejvíce. Vytváření čtenářů v nekonečném textu s monstrózními odstavci je jistým způsobem, jak je ztratit. Dlouhé, složité odstavce a stránky jsou pro technické příručky v pořádku, ale nevhodné pro jednoduché uživatelské příručky. Udržujte je krátká a sladká.

Upozorněte čtenáře na to, co nesmí provádět v různých intervalech. To pomáhá minimalizovat frustraci při učení nového produktu nebo aplikace.

Poskytněte čtenářům další zdroje, které mohou použít k doplnění vašeho průvodce.

Tipy

  • Napište velmi jednoduché pojmy. Nepřijmout žádnou úroveň znalostí. To, co se vám zdá snadné a znalé, nemusí být pro vaše čtenáře. Používejte vysoce kvalitní grafiku, kliparty a fotografie, abyste vylepšili vzhled vašeho dokumentu a zlepšili čitelnost. Udržujte odstavce a popisy krátké.

Varování

Nikdy nepředpokládejte, že čtečka je s tímto produktem obeznámena. Napište každou příručku, jako by ji předtím nikdy neviděli.