1. Krok Získání Obecných Znalostí o Uživatelská Příručka Šablony
Před použitím Uživatelská Příručka Šablony a další nástroje, které jsem vyvinul pro Philip, jsem se chtěl ujistit, že máme stejný výchozí bod. Poskytl jsem mu některé obecné informace o uživatelských pokynech as některými dobrými příklady stávajících uživatelských příruček.
tyto informace jsem uvedl níže.,
jaká je definice uživatelské příručky?
uživatelská příručka je technický komunikační dokument určený k poskytování pomoci lidem o tom, jak používat produkt. Dobrá uživatelská příručka pomáhá uživatelům, jak používat produkt bezpečně, zdravě a efektivně.,
Další jména, nebo jiné formy uživatelská příručka, může být:
- Uživatelská příručka
- Technická dokumentace
- Návod k použití
- manuál
- příručka pro Výcvik
- Příručka pro Rychlý Start
- návodu k Instalaci
- příručka pro Údržbu
- Software návod
Kromě primárního cíle uživatelská příručka (na pomoc uživatel), sekundární cíle by mohlo být vytvoření lepší uživatelskou zkušenost a splnění právních požadavků.
uživatelská příručka se skládá z textových vizuálních informací(ilustrace, screenshoty, tabulky atd.,) pomáhat uživateli při plnění konkrétních úkolů.
uživatel hraje ústřední roli při sestavování uživatelské příručky. Dobře vypracovaná uživatelská příručka poskytuje pouze informace, které jsou relevantní pro zamýšleného uživatele produktu.
uživatelská příručka by měla obsahovat jak procesní informace (podrobné pokyny), tak koncepční informace (informace, které uživatel potřebuje k pochopení procesních informací).
dobrá uživatelská příručka je stručná a používá jazyk bez žargonu. Dobrá uživatelská příručka by měla odpovědět, jak a jaké otázky., Měly by obsahovat informace o tom, co se stane, pokud úkol není proveden správně.
v některých případech je produkt určen pro použití různými typy uživatelů. Typickými typy uživatelů jsou koncový uživatel, instalátor, inženýr údržby a operátor. Každý typ uživatele potřebuje jiný přístup, pokud jde o jazyk, který má být použit, tón hlasu a poskytnuté koncepční informace.
jaké informace by měly být v uživatelské příručce?
různé druhy produktů potřebují uživatelskou příručku. Produktem může být systém, nástroj, zařízení, nástroj, software nebo aplikace.,arnings
Použití uživatelská příručka šablony
hlavní nástroj, který jsem vyvinul ve snaze pomoci Philip vypracovat jeho uživatelské příručky je Uživatelská Příručka Šablony., Šablona obsahuje všechny informace a další ze seznamu výše. Splňuje požadavky na jeho výrobek.
šablona uživatelské příručky může být použita pro vytvoření vaší příručky pro váš systém, nástroj, zařízení, přístroj nebo pro vytvoření instalační příručky, softwarové příručky, provozní příručky, příručky pro údržbu nebo příručky pro školení.
na Základě první šablonu pro Filipa, jsme vyvinuli šablony pro následující skupiny výrobků:
- zdravotnická Zařízení
- Hračky
- Stroje
- Elektronika
Jaké formáty má uživatel ruční?,
uživatelské příručky mohou být poskytovány buď v papírovém formátu nebo jako elektronický dokument (PDF nebo umístěné online nebo na zařízení v HTML). Šablona uživatelské příručky je dokument MS Word, který lze vytisknout nebo umístit online.
uživatelské příručky lze vytvořit pomocí různých nástrojů. Každý nástroj má své vlastní výhody a nevýhody., možný obsah
Vše v jednom řešení
Omni-platforma publikace
Obsahuje výchozí uživatelská příručka šablony
Uživatelská příručka příkladů
Při přípravě a uživatelská příručka s pomocí Uživatelské Příručky Šablony, to může být užitečné mít některé dobré příklady., Prostřednictvím následujících odkazů si můžete stáhnout návod k použití vzorku pro dokumentaci:
- IKEA návod k instalaci
- Jura uživatelská příručka
2. Krok Identifikaci Uživatele(y), Vaše Uživatelské Příručce Šablony
Ok, takže teď Filip má nějaké základní znalosti o uživatelské příručky. Pojďme se ponořit do detailů a akcí.
Pokud chcete napsat příručku, která pomáhá vašemu uživateli řešit problémy, musíte nejprve definovat, kdo je váš uživatel. To lze provést vytvořením uživatelského profilu, také pojmenovaného persona.,
s persona, uděláte nějaké rozumné předpoklady o vlastnostech vašeho uživatele. To je nejen užitečné pro vytváření uživatelských pokynů, ale je to zásadní prvek na začátku vývoje jakéhokoli produktu! Jako vzdělaný inženýr průmyslového designu jsme takto zahájili všechny naše konstrukční úkoly.
při kontrole webových stránek ISOVOX jsem nenašel ani jasný popis jejich zamýšlených uživatelů. Proto jsem požádal Philipa, aby definoval své uživatele a odpověděl na otázky jako:
- kdo je uživatelem vašeho produktu?,
- je produkt používán profesionálně nebo hlavně soukromě?
- jaké další technické zkušenosti mají? Co popisuje uživatele?
vytvořil jsem šablonu, která obsahuje otázky. Požádal jsem Philipa, aby vyplnil šablonu.
šablonu můžete použít sami k určení, kdo je váš uživatel. Vezměte prosím na vědomí, že druhá karta obsahuje také Philipovy odpovědi, takže máte příklad toho, jak lze list použít.
akce: použijte šablonu k popisu vašich uživatelů.
jsem velkým fanouškem vizualizace věcí., Pokud tedy chcete definovat svého uživatele o krok dále, Navrhoval bych, abyste vizualizovali svého uživatele ve formě osobnosti. Při vytváření persona dáváte svému uživateli jméno, věk a cetera, takže se stává skutečnou osobou, která zastupuje vašeho uživatele.
Udělal jsem to pro Philipa., Tohle je výsledek:
Akce: Vytvořit vizualizaci vašeho uživatelského
Pokud chcete vědět více o definování své publikum a vytváření osobnosti:
Krok 3 Vytvoření Témata pro Své Uživatele Problémů
Začněte s identifikací problémů, které váš uživatel(é) mohou vyskytnout během životního cyklu produktu, a že s/on chce vyřešit. Typické problémy mohou zahrnovat: instalace produktu, používání výrobku, bezpečné používání výrobku, udržování produktu a Likvidace produktu.,
Pokud je problém příliš složitý, můžete jej rozdělit na kousky.
požádal jsem Philipa, aby identifikoval problémy a řešení, se kterými by se jeho uživatel mohl setkat během životního cyklu produktu. Za tímto účelem jsem vytvořil další šablonu pro Philipa. V levém sloupci karty životního cyklu jsou uvedeny fáze životního cyklu produktu. Ty jsou odvozeny z mezinárodního standardu pro uživatelské pokyny, IEC / IEEE 82079. Naše šablony uživatelské příručky jsou v souladu s tímto standardem.
Na kartě životního cyklu vidíte, jak Philip upravil životní cyklus na svůj vlastní produkt.,
akce: pomocí této šablony a pokynů na první kartě identifikujte problémy, které může mít váš uživatel během životního cyklu Vašeho produktu, a prezentujte jejich řešení.,
Pokud chcete vědět více o definování problémů uživatele a vytváření témat:
- Téma-based authoring
- Minimalismus
- Informace o mapování
- Bloků
4. Krok Definovat Strukturu Uživatelská Příručka Šablony
Filip má teď problémy uživatel může mít s jeho výrobkem během jeho životního cyklu, a on má teď napadlo řešení, jak vyřešit problém. Jinými slovy: Philip definoval témata pro svou uživatelskou příručku., Každé téma může být pouze o jednom konkrétním předmětu, má identifikovatelný účel a musí být schopen stát sám.
téma by mělo odpovědět pouze na otázku jednoho uživatele. Uživatel chce vyřešit jeden problém najednou. Když uživatel problém vyřešil, půjde a vyřeší další problém.
téma se stane sekcí v uživatelské příručce. Může to být kapitola nebo (dílčí)odstavec. Jakmile uživatel hledá odpověď na svůj problém, použije obsah, aby zjistil, jak se k této odpovědi dostat.,
jsem požádal Filipa, aby se struktura témat a definovat své místo v uživatelská příručka, přiřazením určité téma do konkrétní kapitoly nebo (pod)odstavcem. Výsledek lze vidět na kartě ToC.
AKCE: Chcete-li definovat strukturu vaší uživatelské příručky:
- Zkopírujte obsah z karty životního cyklu na kartu ToC.
- na kartě ToC nahraďte Název produktu vlastním názvem produktu.
- přidejte sloupec doleva. Pojmenujte to „sekce“.
- v případě potřeby Uspořádejte své sekce logicky.
- určete, jaká témata se stanou kapitolami přidáním čísel kapitol., Začněte číslování přípravný produkt pro použití s číslem 4. V dalším kroku přidáme další kapitoly.
- určete, jaká témata se stanou odstavci přidáním čísel sekcí.
- určete, jaká témata se stanou podkapitolami přidáním čísel podsekce.
Nyní jste vytvořili obsah (ToC). ToC je obrys Vaší uživatelské příručky. Později přidáme další témata / sekce, jako je Úvod, bezpečnostní informace atd., takže se nemusíte starat o přidání, že teď.,
Krok 5 Vytvořte smysluplné nadpisy
každé téma v uživatelské příručce získá svůj vlastní Nadpis. Nadpisy jsou (dílčí)Názvy, které předcházejí skutečnému textu. Objevují se v ToC, takže uživatel může přejít na potřebné informace.
takže Philip právě vytvořil (sub-)tituly pro svá témata.
protože položky ToC hrají tak důležitou roli při pomoci vašemu uživateli najít si cestu a pomoci jim přeskočit to, co není důležité, potřebují trochu více pozornosti.
v podstatě byste se měli pokusit pracovat se třemi úrovněmi nadpisů: nadpisy první, druhé a třetí úrovně.,
Nadpis první úrovně popisuje, o čem je celá kapitola nebo sekce (např. instalace produktu). Nadpisy druhé úrovně by měly používat styl frázování „jak co“ (např. Jak sestavit výrobek a jak provést elektrickou instalaci). Nadpis třetí úrovně používá podstatné jméno-fráze (např. Obsah balení a nástroje, které mají být použity).
požádal jsem Philipa, aby přesměroval jeho nadpisy a vzal na vědomí následující obecné pokyny:
- použijte strukturu, jak je uvedeno výše pro Nadpis první, druhé a třetí úrovně.,
- ujistěte se, že nadpisy jsou samovysvětlující. Nadpis dělat palačinky je mnohem více uživatelsky orientované než pomocí MagicCook5000.
- ujistěte se, že Nadpis pokrývá celé téma. Pokud se sekce týká údržby a opravy výrobku, byla by údržba nadpisu neúplná.
- pokud je to možné, zkuste vynechat články na začátku nadpisů
akce: napište nové nadpisy pro vaše položky ToC.
ToC společnosti Philips se smysluplnými nadpisy najdete na kartě ToC W. smysluplné nadpisy.,
6. Krok Určení Právní Obsah
Závislé na trhu, kde váš produkt je umístěn v nebo do provozu, a v závislosti na výrobku skupina výrobků patří, zvláštní právní předpisy se vztahuje na váš produkt.
právní předpisy obecně vyžadují, aby byl váš výrobek „bezpečný“, a proto poskytují obecné bezpečnostní požadavky, které by měl váš výrobek splňovat.
tyto požadavky zahrnují také požadavky na obsah Vaší uživatelské příručky a bezpečnostní pokyny.,
Chcete-li prodat svůj produkt na konkrétním trhu, měli byste se ujistit, že Vaše uživatelská příručka splňuje tyto požadavky.
Tyto dva články níže vám řekne, jak si můžete přesně zjistit, které právní předpisy se vztahují na váš produkt pro Evropský a AMERICKÝ trh a jaké jsou požadavky pro vaše uživatelská příručka. Pro tip: Pokud je již k dispozici prohlášení o shodě, najdete tam příslušné směrnice.,
- Jak Vytvořit Vyhovující Příručky pro EU
- Jak Vytvořit Vyhovující Příručky pro NÁS
Filip nevěděl, je třeba provést tyto kroky, jako šablonu použil již obsahoval právní obsah, požadované příslušnými směrnicemi.
Pro jeho produktu, to znamená, že jsou zapotřebí následující informace pro uživatele, příručka pro jeho produktu:
EU (příslušné označení CE směrnic: LVD, EMC, RoHS, WEEE, REACH):
- uživatelská příručka by měly být přeloženy do jazyku(jazycích) země, kde je výrobek prodáván.,
- uživatelská příručka by měla popisovat zamýšlené použití výrobku.
- uživatelská příručka by měla popisovat přiměřeně předpokládané nezamýšlené použití výrobku.
- je-li to vhodné, je třeba uvést nesoulad v obytných oblastech.
- na výrobku by měl být uveden typ, šarže nebo sériové číslo nebo jiný prvek umožňující identifikaci výrobku. Pokud je výrobek příliš malý, může být umístěn v uživatelské příručce.
- na výrobku by měl být uveden název, registrovaný obchodní název nebo registrovaná ochranná známka a poštovní adresa., Pokud je výrobek příliš malý, může být umístěn v uživatelské příručce.
- měla by být provedena analýza rizik k určení zbytkových rizik souvisejících s použitím přípravku. Za účelem informování uživatele o opatřeních, která mají být přijata, musí být poskytnuty bezpečnostní informace.
- informace o OEEZ musí být zahrnuty
- informace o obalovém odpadu.
kromě této legislativy existuje také mezinárodní standard pro uživatelské příručky, IEC / IEEE 82079-1: 2019. Tato norma byla v EU harmonizována., Soulad s harmonizovanými normami poskytuje předpoklad shody s odpovídajícími právními předpisy!
šablona uživatelské příručky splňuje tento standard.
také jsem vytvořil kontrolní seznam IEC 82079, který lze použít k dvojité kontrole, zda vaše uživatelská příručka splňuje tento standard.
Chcete-li vytvořit mezinárodně kompatibilní uživatelskou příručku, měli byste se vždy ujistit, že vaše příručka splňuje požadavky EU, USA a 80279.,
Akce: K určení právních požadavků na uživatelská příručka:
- Postupujte podle kroků 1-2 z EU, dodržování předpisů a/nebo kroky 1-6 z USA souladu článcích určit právní rámec pro vaše pokyny.
- prostudujte si kontrolní seznam IEC 82079, abyste zajistili, že vaše příručka splňuje normu 82079.
v tomto videu vysvětluji, jak můžete vytvořit příručku, která vyhovuje standardu 82079:
do obchodu
Krok 7 Stáhněte si a připravte šablonu uživatelské příručky
nyní může Philip zahájit skutečné vytvoření své uživatelské příručky.,
požádal jsem ho, aby upravil obsah šablony podle vlastního obsahu. Bez odstranění a povinných prvků samozřejmě…
pamatujete si z kroku 4, že jsem požádal o zahájení číslování sekcí kapitolou 4? Jakmile si stáhnete uživatelskou příručku template doc sami, uvidíte, že bylo přidáno několik standardních kapitol, stejně jako některé dodatky.,
Akce: upravit uživatelská příručka šablony:
Pokud chcete pracovat s free šablonu:
- Stáhněte si zdarma user manual template Word 2013 nebo 2007
- Změny hlavičky sekcí podle svého Obsahu. Upozornění! Neupravujte obsah. Obsah může být automaticky aktualizován, jakmile jste upravili záhlaví sekce.
- přidejte povinný obsah podle kroku 6 vaší příručky.
- pokud je to možné, upravte oddíly 1-3 a dodatky podle vašich vlastních potřeb.,
Nebo použít jeden z našich placených šablon, které obsahují všechny povinné obsahu, jako Philip udělal:
- Zdravotnické Prostředky EU
- zdravotnická Zařízení
- Strojní zařízení EU
- Stroje
- Elektronika EU
- Hračky EU
Krok 8 Vytvořit Obsah pro Vaše Uživatelská Příručka Šablony
napíšeme Zamýšlené Použití
Účel vašeho produktu, nebo lépe: zamýšlené použití, je srdce uživatelská příručka a tvoří základ zajištění bezpečné a zdravé používání produktu.,
způsob, jakým je zamýšlené použití popsáno, také určuje vaši odpovědnost a ovlivňuje další obsah uživatelské příručky.
nejvíce právních předpisů vyžaduje, abyste do uživatelských pokynů zahrnuli popis zamýšleného použití.
mezinárodní standardní pokyny pro uživatele, IEC 82079-1, poskytuje následující definici pro zamýšlené použití:
vyčerpávající škálu funkcí nebo zamýšlenými aplikacemi definovány a navrženy dodavatelem produktu,
Tím, že popisuje zamýšlené použití, určit bezpečné obálky produktu., A jakmile určíte zamýšlené použití, můžete se zaměřit na poskytování pouze těch bezpečnostních a uživatelských pokynů, jak používat výrobek v dané obálce.
navíc k zamýšlenému použití vyžaduje mnoho dalších norem, směrnic a předpisů také popis přiměřeně předvídatelného zneužití.
například rozumně předvídatelné zneužití agresivního pracího prostředku by mohlo být jeho použití v prostředí pro zpracování potravin.
věnovat příliš malou pozornost popisu přiměřeně předvídatelného zneužití ovlivní odpovědnost společnosti.,
zákony / nařízení o odpovědnosti za výrobek nesou odpovědnost výrobce za vadný výrobek. Pokud je třeba určit defektnost produktu, budou vzaty v úvahu všechny okolnosti. To zahrnuje přiměřeně předvídatelné použití výrobku.
popis zamýšleného použití určuje, které pokyny jsou uvedeny ve zbytku příručky. Pokud se například chladicí systém používá pouze k chlazení určitých léků, je třeba popsat pouze tyto postupy.,
pokud lze rozumně předpokládat, že chladicí systém může být použit jako systém pro chlazení orgánů, mělo by to být popsáno v pokynech. Tím vy, jako výrobce, omezíte svou odpovědnost a můžete se soustředit pouze na popis toho, jak používat systém k chlazení léků.
akce: napište zamýšlené použití a přiměřeně předvídatelné zneužití Vašeho produktu.
Obrázek 1. Rozumně předvídatelné zneužití?,
napište bezpečnostní varování na základě analýzy rizik
přestože zamýšlené použití bylo nyní jasně definováno, neznamená to, že používání produktu je zcela bez rizika.
Chcete-li zjistit nebezpečí, která přicházejí s použitím produktu, můžete provést analýzu rizik. Analýza rizik může být také povinná pro určité skupiny výrobků, jako jsou nízkonapěťová zařízení, hračky, stroje a zařízení pro použití ve výbušné atmosféře.standardy
, stejně jako ISO 12100, byly vyvinuty o tom, jak provést analýzu rizik., ISO 12100 také poskytuje metodu pro přijímání zmírňujících opatření: třístupňovou metodu. Podle této metody je následující hierarchii opatření ke snížení rizika:
- zajišťování bezpečnosti při navrhování opatření
- Ochrana a doplňková ochranná opatření
- Informace pro použití
To znamená, že uživatelská příručka by měla varovat o zbytkových rizicích spojených s používáním výrobku. To se provádí s bezpečnostními varováními.,
KUP TEĎ
dobrá bezpečnost varování popisuje povahu nebezpečné situaci, důsledky ne vyhnout nebezpečné situaci, a způsob(y), aby se jí vyhnuli.
pro označení stupně nebezpečí, se kterým se může uživatel setkat, je třeba použít signální slova „nebezpečí“, „varování“ a „opatrnost“.
podívejte se na následující bezpečnostní zprávy:
varování! Rotující části. Riziko vážných zranění. Držte ruce čisté. Výluka/Tagout před servisem.
pak chcete upozornit uživatele, kde může dojít k nebezpečné situaci. ANSI Z535.,6 standard popisuje následující umístění v uživatelské příručce, kde by to mohlo být:
- seskupené do samostatné kapitoly.
- V první části na konkrétní sekce:
- Vložené do postupu:
1. Provést.
2. Udělat. Varování! Toto jsou vložené bezpečnostní zprávy. Obecný text obecný text obecný text obecný text.
3. Provést.,
- V Předmluvě doplňujících směrnic mohou být umístěny, například, Přečtěte si všechny pokyny před použitím nebo uschovejte tyto pokyny pro budoucí použití, mohou být umístěny v úvodu uživatelské příručky.
v EU může být v závislosti na druhu výrobku povoleno poskytovat pouze bezpečnostní informace v tištěné podobě a zbytek informací online.
abych pomohl Philipovi vytvořit a umístit bezpečnostní zprávu, vytvořil jsem další šablonu.
akce: proveďte analýzu rizik a vytvořte bezpečnostní zprávy pomocí této šablony.,
Vytvořit všechny další obsah
Nyní jsem požádal Filipa, aby vytvářet všechny další obsah, jako jsou postupy, technické specifikace a právní informace.
dal jsem následující tipy:
- vyloučit zbytečný materiál, aby se zabránilo přetížení informací (například propagace prodeje, rozsáhlé opakování atd.).
- ujistěte se, že podmínky jsou uživateli známy, technické vlastnosti a podmínky jsou dobře vysvětleny a důsledně používají termíny.
- popište všechny předpoklady, které by měly být splněny před zahájením skutečných pokynů., To může také popisovat speciální nástroje nebo prostor pro údržbu a opravy.
- poskytují koncepční informace, pokud jsou informace nezbytné pro odpovídající pochopení a plnění úkolů.
- vždy psát téma založené.
- použijte tučné písmo pro všechny prvky produktu.
- použijte Průvodce stylem, který vám pomůže lépe psát a formátovat dokumentaci.
- uveďte, kdy chcete přidat obrázek pro lepší pochopení později.
- ujistěte se, že slova a fráze nejsou příliš komplikované nebo příliš sofistikované.,
- Používejte jednoduché / standardizované a krátké fráze: jedna věta-jeden příkaz.
- nedávejte příliš mnoho informací do jedné věty.
- použijte přímé aktivní hlasové a asertivní příkazy.
- používejte slova jako podstatná jména a slovesa důsledně, abyste předešli nejednoznačnosti.
- Chcete-li napsat lepší pokyny, použijte zásady minimalismu v technické komunikaci a zjednodušenou technickou angličtinu.
akce: vytvořte veškerý další obsah pro vaši uživatelskou příručku.
Opět platí, že pro většinu skupin produktů jsou k dispozici placené šablony, které by mohly práci usnadnit., Tyto šablony obsahují všechny právní texty, povinné informace o likvidaci, prohlášení o autorských právech a splňují normu IEC 82079 O uživatelských pokynech.
bezpečnost varování ve správné poloze
Při použití šablony na tvorbě bezpečnostní zprávy, jsem požádal Filipa, aby uvést, zda bezpečnostní zpráva je doplňující směrnice, nebo by měly být umístěny jako skupinové, oddíl nebo vložené bezpečnostní zprávy.
nyní byl vytvořen veškerý text, bezpečnostní zprávy lze umístit na správné místo.,
akce: umístěte všechny bezpečnostní zprávy na správné místo v uživatelské příručce.
Krok 9 Přidejte navigaci do šablony uživatelské příručky
uživatelská příručka by měla poskytnout pomoc lidem poskytnutím informací o tom, jak produkt používat. Nalezení správných informací, které řeší problém uživatele, by mělo trvat co nejméně času.
vytváření smysluplných nadpisů je jedním z nástrojů, které pomáhají uživatelům při hledání informací., Nicméně, existuje několik dalších nástrojů, které pomáhají uživateli najít informace, které on/ona chce, jako:
- obsah
- číslování
- Index
jsem se zeptal Filipa, jak aktualizovat obsah a přidat číslování stránek a index.
akce: přidejte nebo aktualizujte svůj obsah, číslování stránek a index.
Krok 10 nechte si zkontrolovat uživatelskou příručku
Philip nyní vytvořil návrh verze své uživatelské příručky pomocí šablony uživatelské příručky. Tuto verzi nazýváme návrh textového obsahu.,
Jako Filip má obchodní partner a vývojář s in-hloubkové technické znalosti produktu, jsem požádal Filipa, aby jim přezkoumat dosavadní práci.
jak jeho obchodní partner, tak vývojář poskytli zpětnou vazbu. Philip použil tuto zpětnou vazbu k optimalizaci uživatelské příručky.
akce: pošlete návrh verze uživatelské příručky komukoli ve vašem týmu, který by mohl poskytnout zpětnou vazbu. Požádejte je, aby před odesláním zpět spojili veškerou zpětnou vazbu do jednoho dokumentu. To stimuluje diskusi o členech vašeho týmu a zabraňuje neshodám v pozdější fázi.,
krok 11 Vytvořte obrázky
jakmile je uživatelská příručka přezkoumána a optimalizována, texty jsou víceméně definitivní. To znamená, že všechny obrázky mohou být nyní vytvořeny a přidány k obsahu.
důvodem, proč čekat, až budou texty připraveny, je to, že vytváření nebo úpravy obrázků mohou být časově náročné. Protože obrázky by měly podporovat, nahrazovat nebo rozšiřovat text, chcete počkat, až je vytvoříte, dokud nebudou texty konečné.
obrázky v uživatelských příručkách mohou obsahovat ilustrace, fotografie, screenshoty, tabulky, diagramy a schémata.,
Existuje mnoho skvělých nástrojů, které vám pomohou vytvořit vaše obrázky, jako jsou:
- Snagit nebo Adobe Photoshop pro úpravy screenshoty nebo fotografie
- Solidworks Composer nebo Google Sketchup pro vytváření čárových výkresů
- Lucidchart nebo Microsoft Visio pro diagramů a schémat
doporučuje Filip nebude používat fotografie jako levná alternativa pro ilustrace. Fotografie často nejsou tak informativní, protože obsahují příliš mnoho informací. Kromě toho mohou fotografie způsobit, že uživatelská příručka bude vypadat chaoticky.,
Z tohoto důvodu Philip použil Google Sketchup k vytvoření svých ilustrací.
akce: vytvořte obrázky pro uživatelskou příručku.
Pokud chcete vědět více o vytváření obrazů:
- Pomocí textu, obrázky nebo videa
- Vytvoření IKEA-ish manuály
Krok 12 Závěrečná Kontrola Uživatelská Příručka Šablony
předtím, Než jsme začít dělat to vypadat hezky a přeložit obsah, chceme si být jisti, že obsah je kompletní.
za tímto účelem jsem požádal Philipa, aby použil kontrolní seznam.,
Akce: l ujistěte se, že vaše uživatelské příručce, splňuje všechny příslušné požadavky IEC 82079-1:2012 pomocí tohoto kontrolního seznamu.
krok 13 Vytvořte si šablonu uživatelské příručky
dobře navržená příručka přispívá k lepší značce a uživatelskému zážitku.
šablonu uživatelské příručky můžete upravit v MS Word přidáním loga společnosti a úpravou písma, barev a cetera, ale to může mít omezení.
když víte, jak pracovat s Adobe Indesign, nebo jste ochotni se s ním naučit pracovat, nabídne vám to mnohem větší možnosti designu.,
vytvořil jsem tuto šablonu v InDesignu a požádal Philipa, aby ji upravil tak, aby odpovídala jeho identitě značky.
akce: upravte šablonu uživatelské příručky tak, aby odpovídala vaší identitě značky, nebo si stáhněte šablonu uživatelské příručky InDesign a upravte ji.
krok 14 DTP Works
DTP je zkratka pro Desktop Publishing a Wikipedia ji popisuje jako „vytváření dokumentů pomocí dovedností rozvržení stránky na osobním počítači primárně pro tisk“.
Philip má nyní jak obsah své uživatelské příručky (soubor Word), tak šablonu uživatelské příručky (soubor InDesign)., Obsah je třeba vložit do šablony InDesign. Toto se nazývá publikování na ploše.
akce: umístěte obsah ze souboru Word do šablony Indesign. Pokud jste se rozhodli nepoužívat šablonu InDesign, ale přilepenou k souboru Word, můžete tento krok přeskočit.
Krok 15 Přeložit a Publikovat své Návody
v Závislosti na trhu, na kterém se chystáte prodat svůj produkt, budete možná muset přeložit uživatelské příručce.
některé obecné tipy:
- vyhledejte překladatele s podobnými zkušenostmi., Může to být překladatel, který má zkušenosti s překladem technického obsahu, s podobnými produkty nebo s překladem uživatelských příruček.
- Pokud potřebujete přeložit do několika jazyků, práce s překladatelskou agenturou vám může ušetřit spoustu času.
- zeptejte se překladatele nebo agentury na jejich kvalitní postupy a kdo bude text po překladu revidovat.
- jak víte, že váš produkt je nejlepší a kdo je vaše publikum, může být dobré poskytnout překladateli nebo agentuře slovníček nebo seznam s terminologií, kterou chcete použít.,
- Podívejte se na překladatele, který může pracovat přímo ve vašem Word nebo InDesign souboru nebo najít agenturu, která může dělat DTP funguje stejně. Případně to samozřejmě můžete udělat sami.
protože Philip prodá svůj produkt v USA i EU, rozhodl se spolupracovat s agenturou.
akce: Najděte překladatele nebo agenturu, která vyhovuje vašim potřebám a nechte si přeložit uživatelskou příručku.
obecně by uživatelská příručka měla být k dispozici ve formátu, který je snadno přístupný uživateli. To lze vytisknout nebo použít online nebo na zařízení.,
jako uživatel chce informace v okamžiku, kdy on / ona to potřebuje, a tak nemyslí v kanálech, nejlepší přístup by bylo poskytnout pokyny omni-platform.
v Evropské unii je pro některé skupiny produktů stále omezeno poskytování uživatelské příručky vytištěné s výrobkem.
od dubna 2016 však mohou být pokyny mnoha skupin produktů dodány spíše v jiném formátu než v tisku. Existuje však jedna výjimka.
bezpečnostní informace musí být dodány v papírové podobě spolu s výrobkem., Kromě toho by na žádost spotřebitele měla být spotřebiteli zpřístupněna papírová uživatelská příručka.
Philip se rozhodl pro následující:
- poskytuje tištěnou úplnou příručku s výrobkem, včetně bezpečnostních pokynů.
- vytvořil samostatný Průvodce rychlým startem, který má být také vybaven produktem.
- umístil pdf verzi plné příručky online.
- na svých webových stránkách vytvoří sekci online nápovědy s HTML verzí uživatelské příručky. Zde může také přidat videa., A optimalizací HTML verze pro vyhledávače usnadňuje jeho uživateli najít informace pro jeho uživatele
závěr
to je vše, co je k tomu. Takto vytvořil Philip kompatibilní uživatelskou příručku s pomocí šablony uživatelských příruček a dalších dostupných nástrojů, které jsem poskytl.
nejlepší na tom všem je, že můžete získat stejné výsledky jako Philip tím, že budete postupovat krok za krokem, jak vytvořit uživatelskou příručku.