Pokyny pro redakční práce s pohledem Cheat Sheet
Pohledy Cheat sheet a kompozitní pohledy Cheat sheet umožňují uživateli dosáhnout cíle provedením sekvence kroků. Tyto pokyny se zabývají tím, kdy používat pohledy Cheat sheet a jak nejlépe napsat pohled Cheat sheet.
Kdy vytvářet pohledy Cheat sheet
Pohledy Cheat sheet se výborně hodí pro úlohy, které sestávají z kroků, které vedou ke konkrétnímu cíli, jako např. sestavení jednoduché aplikace. Tento cíl musí být dobře definován, aby uživatel po provedení všech kroků v pohledu Cheat sheet rozpoznal úspěch. Dobrými kandidáty na pohledy Cheat sheet jsou výukové programy, kde je cílem naučit se provádět konkrétní úlohu. Pohledy Cheat sheet budou obvykle obsahovat až 10 kroků a mohou být dokončeny maximálně za půl hodiny.
Pro delší úlohy zvažte použití kompozitního pohledu Cheat sheet.
Kdy vytvářet kompozitní pohledy Cheat sheet
Kompozitní pohledy Cheat sheet se používají k provádění úlohou, která je příliš rozsáhlá na to, aby bylo možné ji popsat v jediném pohledu Cheat sheet, nebo která má více cílů. Kompozitní pohled Cheat sheet lze používat k popisu sekvence úloh, z nichž každá staví na svém předchůdci.
Kdy nepoužívat pohledy Cheat sheet
Pohledy Cheat sheet fungují nejlépe, když lze problém vyřešit pomocí sekvence jednoduchých kroků. Pohledy Cheat sheet nepředstavují náhradu systému nápovědy, který umožňuje vytvoření stránek HTML s bohatou grafikou a přímým přístupem k informacím pomocí vyhledávání a hypertextových odkazů. Pohledy Cheat sheet nejsou určeny pro úlohy, které vyžadují od uživatele vstup velkého množství textu.
Pokyny pro vytváření pohledu Cheat sheet
- Zvolte krátký a smysluplný titulek.
- Kdykoli je to možné, využívejte v pohledu Cheat sheet odkazy na systém nápovědy, abyste poskytli podklady nebo podrobnější informace.
- V případě více než 10 kroků zvažte přepsání na kompozitní pohled Cheat sheet.
- Kdykoli je to možné, k provádění jednoduchých zdlouhavých úloh, jako např. otevírání perspektiv, otevírání prostředků nebo provádění průvodců, využívejte příkazy. Dbejte rovněž, abyste
poskytli popis způsobu dosažení stejného efektu bez použití příkazu.
- Zajistěte, aby bylo možné přeskočit příkazy, pokud se uživatel rozhodne provést
kroky ručně.
- V případě kroků, které otevírají dialogová okna, určete dialog="true". Tím zajistíte, že
se pohled Cheat sheet otevře v "paletě" vpravo od většiny dialogových oken.
- Uspořádejte kroky takovým způsobem, aby uživatel často rozpoznal viditelné známky
úspěchu. Pohled Cheat sheet, který provádí mnoho různých změn do zdroje Java
a teprve potom spustí aplikaci, byste měli přepsat tak, aby aplikace byla spuštěna po každé změně zdroje.
- Ujistěte se, že uživatel porozumí tomu, proč jednotlivé kroky provádí.
- Místo popisu více možností provádění kroku vyberte nejjednodušší
způsob vyžadující nejméně popisu.
- Používejte značky zalomení řádku (<br/>) ke zlepšení čitelnosti.
- K rozložení kroků na menší kroky lze používat dílčí položky.
- Ne všechny pohledy Cheat sheet budou dílčí položky vyžadovat.
- Začněte text štítku dílčí položky akčním slovem, jako např. "Zadat", "Rozbalit",
"Vybrat" apod.
- Zřetelně určete text rozhraní štítků dílčích položek pomocí uvozovek, abyste umožnili uživatelům rozlišit text pokynů od textu rozhraní, který potřebují k vyhledání a zajištění interakce.
- Každá dílčí položka by měla být zodpovědná za jednu atomickou úlohu, jako např. vstup jedné hodnoty.
- Do posledního kroku pohledu Cheat sheet vždy přidejte prvek <onCompletion>.
- Otestujte pohledy Cheat sheet různou velikostí pohledu Cheat sheet.
- Otestujte pohledy Cheat sheet s otevřeným pohledem Protokol chyb, abyste viděli, zda jsou do protokolu zapisována varování.
Pokyny pro vytváření kompozitního pohledu Cheat sheet
- Kompozitní pohled Cheat sheet by měl obsahovat úlohy, které spolu souvisejí prostřednictvím společného motivu.
- Každá úloha v rámci kompozitního pohledu Cheat sheet by měla mít řádně definovaný cíl.
- Pro rozpoznání úspěchu používejte prvky <onCompletion>.
- Názvy úlohy by měly být krátké a stručné.
- Složité problémy mohou být vyřešeny použitím úloh, které stavějí na svých předchůdcích.
- Je-li úloha volitelná, používejte skip="true".
- Kvůli konzistenci dbejte, aby úvod a název jednoduchého pohledu Cheat sheet odpovídal úvodu a názvu zadanému v kompozitním pohledu Cheat sheet.
- Zřetelně určete text rozhraní popisu úlohy pomocí tučného formátování.
- Sekvence byste měli používat pouze tehdy, je-li důležité vynutit si pořadí spouštění úloh.
Související odkazy
Práce s pohledy Cheat sheet
Práce s kompozitními pohledy Cheat Sheet
Jednoduché pohledy Cheat Sheet
Kompozitní pohledy Cheat sheet