POKYNY: VLASTNOSTI, STRUKTURA A PŘÍKLADY - KULTURNÍ SLOVNÍK - 2025

Instruktážní je dokument, který se snaží dát nějaké informace o tom, jak udělat něco konkrétního. Tyto texty slouží jako vodítko pro jednotlivce, aby věděli, jak správně provádět akci nebo být informováni o něčem.

Většina pokynů má písemný průvodce nebo text s pokyny a některé přidružené obrázky (například diagramy), které mohou jednotlivci pomoci pochopit otázku.

Myšlenka je taková, že pokyny jsou psány netechnickým způsobem tak, aby byly srozumitelné pro co největší počet lidí.

Úroveň technické terminologie a úroveň obsahu se musí lišit od odborné příručky, protože pokyny musí být zaměřeny na běžného občana.

Z tohoto důvodu je důležité definovat, komu je průvodce určen; různí čtenáři budou mít různé požadavky.

Pokyny by navíc měly mít strukturu, která zahrnuje kromě jiných prvků také obal, úvod, glosář, obecný popis a pokyny.

Jak název napovídá, pokyny jsou texty psané, aby lidem pomohly pochopit, jak používat systém.

Obecně jsou tyto pokyny nezbytné při implementaci technologického softwarového systému, montáži nábytku nebo návodech, jak používat elektronické zařízení.

Pokyny by měly být první položkou, kterou si musíte přečíst při nákupu nového produktu.

Čtením návodu k použití lze mnoho pochybností o něm vyřešit, aniž byste museli vyžadovat technickou podporu nebo podporu od výrobce.

Hlavní charakteristiky pokynů

- Zahrnuty jsou podrobné pokyny k používání produktu.

- Obsahují absolutně všechny pokyny k produktu, a to všemi možnými způsoby.

- Začínají rychlou jednostránkovou uživatelskou příručkou.

- Sdělují uživateli, jaké funkce produktu jsou a k čemu slouží, nejen jak tyto funkce používat.

- Zohledňují potřeby zdravotně postižených uživatelů (např. Slabozrakost nebo barevná slepota) a poskytují alternativní pokyny pro tyto uživatele, například zvuk, Braillovo písmo nebo větší tisk.

- Používají pouze jeden jazyk.

- Mají efektivní využití barev.

- Její stránky jsou očíslovány a mají index.

- Mají fotografie nebo schémata, která pomáhají pochopit produkt a pokyny.

- Používají čisté a čitelné písmo; to znamená, že nepoužívají patkové fonty.

Struktura

1. Úvod

Obsahuje všechny podstatné informace pro uživatele, aby mohl používat celý systém nebo produkt. Tato část by měla zahrnovat popis funkcí systému a jeho schopností, nepředvídaných událostí a alternativních způsobů provozu, postupných kroků a použití.

Pokud je to možné, použijte grafiku. Tato část také popisuje účel výuky, její organizaci a možné reference.

2 - Kontaktní místa

Tato část identifikuje kódy organizace a týmů, které mohou uživateli pomoci. Pokud existuje linka pomoci nebo helpdesk, je to popsáno v této části.

3 - Primární obchodní funkce

Tato část obsahuje obchodní perspektivu primárních povinností uživatele s ohledem na produkt nebo systém.

4 - Slovník

Zde je slovník pojmů a zkratek použitých v pokynech. Pokud je velmi dlouhý, více než několik stránek, je umístěn jako dodatek.

5- Možnosti systému nebo produktu

Tato část obsahuje stručné shrnutí systému a možností produktu; jeho účel musí být popsán.

Myšlenka je taková, že uživatel chápe funkce a operace systému, včetně specifických funkcí na vysoké úrovni. V případě potřeby by měly být zahrnuty grafy nebo tabulky.

6- Popis funkcí

Je popsána každá konkrétní funkce systému. Mohou být zahrnuty následující položky:

- Účel a použití funkce. Musí být také přidány vztahy s jinými funkcemi.

- případně inicializace funkce.

- Možnosti provádění spojené s funkcí a jejich popis.

- Popis očekávaných vstupů a jejich výsledků.

7- Příprava vstupních funkcí

Tato část obsahuje vstupy potřebné pro správnou funkci systému nebo produktu.

8- Výsledky

Měly by být zahrnuty také očekávané výsledky každé funkce. Tyto výsledky by měly zahrnovat grafiku, text a tabulky, které mohou uživateli pomoci. Dále jsou uvedeny příklady.

9- Návod k obsluze

Seznam procesů souvisejících s provozními pokyny je uveden zde. Například by měl obsahovat postupy pro vstup do systému, pokud jsou použitelné.

Tento postup inicializace by měl popsat, jak nastavit požadovaný provozní režim a jak spustit parametry potřebné k provozu.

10- Údržba

Tato část obsahuje postupy pro zajištění řádného fungování systému nebo produktu.

11 - Chyby

Tato část by se měla věnovat veškerým chybovým zprávám, které by se mohly objevit v systému nebo jakékoli možné poruše zařízení.

Měli byste například zahrnout seznam všech chybových zpráv, které se mohou objevit, co znamenají a jak je opravit.

Příklady pokynů

1- Pokyny k montáži židle

Bezpečnostní

Před použitím nástrojů si přečtěte, pochopte a dodržujte bezpečnostní pokyny pro každý z nich. Pokud tomu nerozumíte, kontaktujte výrobce.

Chraňte oči ochrannými brýlemi, ušima izolací a plícemi respirátor nebo masku.

Stavební plán

Vyřízněte desku 2x4x8 ze dřeva, čtyři desky 1x3x1 a tři desky 5x3x2.

Sestavte stůl podle schématu a spojovací body v rozích označte tužkou. Potom kousky zajistěte hřebíkem a kladivem.

Obdélníky představují pozorované proměnné; proměnné fondu jsou vyjádřeny jako x.

Kruhy představují latentní proměnné a šipky na obrázcích představují vztahy mezi proměnnými.

Mezi speciální funkce patří:

1- Individuální nebo skupinová analýza.

2 - Stratifikace, pravděpodobnosti selekce, replikované váhy a konečné korekce populace.

3 - Maximální odhad pro typy výsledků.

Diagrammer

Může být použit k nakreslení vstupního diagramu. Pro vstup do této funkce otevřete nabídku diagramů v editoru Mplus. K vytvoření diagramu se používá sada nástrojů pro kreslení.

Kalkulačka LTA

Vypočítávají se podmíněné pravděpodobnosti, včetně pravděpodobností latentního přechodu pro různé hodnoty. Lze jej použít výběrem kalkulačky LTA z nabídky Mplus v editoru Mplus.

Reference

1. Ruční průvodce. Obnoveno ze statmodel.com
2. Průvodce nováčkem stavebního nábytku (2017). Obnoveno z sawsonskates.com
3. Tipy pro psaní uživatelských příruček. Obnoveno z userfocus.co.uk
4. Uživatelská příručka. Obnoveno z wikipedia.org
5. Uživatelská příručka. Obnoveno z klariti.com