Varovný rámeček: Kdy a jak ho používat
Pomocí varovných rámečků uveďte konkrétní riziko, vysvětlete jeho důsledek a poskytněte bezpečný postup před nezvratnou, nákladnou, regulovanou nebo nebezpečnou činností.
Varovný rámeček zastaví čtenáře před akcí, která by mohla způsobit materiální újmu. Nejde o běžný způsob zvýraznění. Publikovatelné varování uvádí riziko, důsledek a postup, který se újmě vyhne nebo ji omezí.
Tento živý prvek funguje, protože identifikuje, co se může pokazit, vysvětluje, co bude ztraceno, a poskytuje bezpečný postup před destruktivním ovládacím prvkem. „Buďte opatrní při mazání“ by nestačilo: přesouvá posouzení rizika zpět na čtenáře, aniž by mu říkalo, co opatrné chování znamená.
Proč na tomto prvku záleží
Varování existují proto, aby změnila rozhodnutí dříve, než dojde k újmě. Čtenář, který postupuje podle instrukcí, se obvykle soustředí na dosažení slibovaného výsledku, a proto může přehlédnout upozornění, která vypadají jako běžný doplňkový text. Jasně ohraničené varování přeruší toto momentum v okamžiku, kdy má čtenář stále na výběr. Vytváří záměrnou pauzu, vysvětluje, proč tato pauza má význam, a nabízí bezpečný další krok.
Tento prvek slouží psychologii čtenáře pouze tehdy, pokud ho autoři používají selektivně. Pokud běžná rada, drobná nepříjemnost i nenávratná ztráta dostanou stejné zacházení, čtenáři se naučí, že vizuální signál málokdy něco znamená. Začnou ho přeskakovat. Nadsázka tedy vytváří přesně ten způsob selhání, kterému má varování zabránit: důležitá zpráva je zlevněna, když jsou v sázce skutečné věci. Tón musí informovat, ne strašit.
Strojová extrahovatelnost znamená, že software dokáže varování izolovat a zachovat jeho význam i mimo okolní odstavce. Typový blok s textovým varovným štítkem a samostatným tělem je snáze identifikovatelný než červená věta ukrytá uvnitř kroku. Struktura riziko–důsledek–postup také přežije změny prezentace. Automatizovaný publikační systém může přesouvat obsah mezi Markdown, Hugo a WordPressem, aniž by musel odvozovat, která věta popisuje újmu nebo co má čtenář udělat.
Při mapování prvku se řiďte pravidly psaní prvků . Barva, ikona, tučný text nebo nadpis pojmenovaný „Důležité“ samy o sobě nevytvářejí sémantiku varování. Slova musí zůstat úplná, i když se zkopírují jako prostý text nebo čtou bez vizuálního stylování stránky.
Kdy jej použít
Varování použijte, když se čtenář chystá učinit volbu nebo provést akci s předvídatelným materiálním důsledkem. Prvek je povinný, pokud obsah spadá do některé z těchto kategorií:
- Nenávratná akce: smazání, přepsání, publikace, odeslání, uzavření účtu nebo jiná akce, kterou nelze spolehlivě vrátit zpět.
- Ztráta nebo odhalení dat: záznamy mohou být vymazány, poškozeny, zpřístupněny, přeneseny nebo znepřístupněny.
- Finanční dopad: akce spouští poplatek, obnovuje závazek, spotřebovává placený limit nebo vytváří náklady, které nejsou v okamžiku rozhodnutí zřejmé.
- Riziko pro bezpečnost nebo zdraví: dodržení, kombinování nebo přeskočení instrukce by mohlo způsobit zranění, nemoc nebo zpoždění péče.
- Právní nebo regulatorní riziko: akce by mohla porušit zákon, smlouvu, zásady, licenci, pravidla uchovávání, požadavky na souhlas nebo regulovaný schvalovací proces.
Rozhodujícím faktorem pro zařazení je spouštěč, nikoli preference autora nebo dostupný počet slov. Pokud některý z nich platí, varování nelze zkrátit na vágní označení, přesunout do obecného vyloučení odpovědnosti nebo vynechat, aby se vešlo do šablony. Nejprve zkraťte okolní vysvětlení.
Nepoužívejte varování pro užitečnou zkratku, osvědčený postup, definici, mírnou nepříjemnost, běžný předpoklad nebo vratnou chybu se zřejmým řešením. To jsou téměř zásahy, protože mohou být „důležité“ v běžné mluvě, ale nevyžadují rozhodnutí k zastavení. Požadované předpoklady uveďte v postupu, volitelná vylepšení do tipovacího rámečku a běžné řešení chyb vedle kroku, který opravuje.
Nepoužívejte varování jen proto, že je výsledek nežádoucí. „Nekvalitní titulky mohou snížit kliknutí“ je vysvětlení výkonu, nikoli varování. Stává se materiálem pro varování pouze tehdy, když blízká akce vytváří specifický, materiální důsledek: například změna URL struktury živé stránky bez přesměrování může rozbít příchozí odkazy a odstranit zaindexované cíle. V takovém případě uveďte preventivní postup před změnou.
Kam jej umístit
Varování patří bezprostředně před nejranější akci, které se týká. „Akce“ zahrnuje číslovanou instrukci, příkaz, odeslání formuláře, nákupní ovládací prvek, stažení, doporučení nebo rozhodnutí, podle kterého může čtenář jednat. Rámeček umístěte po dostatečném kontextu k identifikaci situace, ale před první vykonatelnou instrukci. Nikdy neodhalujte riziko až po akci, v poznámkách pod čarou nebo pouze v závěrečném FAQ.
Pokud jedno varování řídí celý sled kroků, umístěte ho před tento sled a pojmenujte jeho rozsah: „Následující tři kroky nahrazují produkční databázi.“ Neopakujte stejné varování uvnitř každého kroku. Pokud pozdější krok zavádí jiné riziko, přidejte druhé varování bezprostředně před tento krok.
Varování nesmí být umístěno přímo vedle jiného upozornění, propagační výzvy k akci nebo dekorativního banneru. Sousedící rámečky soutěží o pozornost a mohou způsobit, že varování vypadá jako součást marketingového bloku. Nesmí oddělovat instrukci od jejího požadovaného vstupu, tvrzení od jeho důkazu ani název tabulky od tabulky samotné. Přidejte prostý přechod nebo restrukturalizujte sekci tak, aby varování jasně kvalifikovalo jedno rozhodnutí.
Právní formulace umístěte podle příslušných zásad, ale provozní varování ponechte vedle rizikové akce. Přesun varování do patičky jen proto, že již existuje vyloučení odpovědnosti, maří jeho účel.
Anatomie
Vykreslený prvek má šest sémantických oblastí:
- Štítek závažnosti: viditelný text, který říká, že se jedná o varování; nesmí být sdělen pouze barvou nebo ikonou.
- Konkrétní nadpis: pojmenovává rozhodnutí nebo riziko, například „Varování: před smazáním exportujte záznamy.“
- Riziko: uvádí, jaká akce nebo podmínka se může pokazit.
- Důsledek: uvádí věrohodný výsledek a koho nebo co ovlivňuje.
- Postup: říká čtenáři, jak se riziku vyhnout, jak ho snížit, ověřit nebo eskalovat před pokračováním.
- Vztah umístění: propojuje varování s následující akcí, kterou řídí.
Legenda zůstává jako živý text stránky, nikoli jako součást obrázku. Tím je každý popisek dostupný pro asistenční technologie a design se může měnit, aniž by specifikace ztratila přesnost.
Příklady designu
Současná knihovna podporuje jednu úroveň varování: Hugo jej vykresluje pomocí type="important". Neexistuje samostatná varianta pro upozornění, varování, nebezpečí, kritické nebo nouzové stavy. Tato záměrná jednoduchost zajišťuje konzistentní volbu autora a snižuje pravděpodobnost, že dva autoři přiřadí stejné újmě různé barvy. Nevýhodou je, že komponenta nedokáže vizuálně odlišit nahraditelnou finanční ztrátu od bezprostředního fyzického nebezpečí. Autoři musí závažnost uvést v nadpisu a důsledku, místo aby spoléhali na výraznější barvu.
Galerie proto testuje jedinou úroveň závažnosti v podporovaných obsahových variantách: výchozí popisek, konkrétní vlastní nadpis, maximálně dva odstavce a úzké zobrazení. Jde o případy vykreslení, nikoli o různé úrovně závažnosti.
Nevytvářejte vlastní závažnosti přidáváním emotikonů, velkých písmen, opakovaných vykřičníků, vlastních tříd nebo nepodporovaných hodnot typu. Pokud knihovna později získá více úrovní, jejich hranice musí být založeny na důsledku a požadované reakci, nikoli na tom, jak silně autor o pasáži cítí.
Parametry
Renderer má pouze vstupy type, title a tělo. Riziko, důsledek a postup jsou redakční pole uvnitř těla; jejich výslovné uvedení v této smlouvě zabraňuje tomu, aby vizuálně platné upozornění publikovalo neúplné vedení.
| Název | Typ | Povinné | Min/max | Výchozí | Zdroj | |
|---|---|---|---|---|---|---|
type | Enum | Ano | Přesně important | Žádná pro tento prvek | Atribut shortcode | |
title | Prostý řetězec | Ano | 3–9 slov; 70 znaků | Výchozí rendereru je Important, ale smlouva o varování vyžaduje konkrétní název | Atribut shortcode | |
risk | Prostý Markdown | Ano | 1 věta; 8–30 slov | Žádné | Tělo, první věta nebo klauzule | |
consequence | Prostý Markdown | Ano | 1 věta; 8–35 slov | Žádné | Tělo za rizikem | |
action | Prostý Markdown | Ano | 1–2 věty; 8–40 slov | Žádné | Tělo za důsledkem | |
body | Markdown | Ano | 25–90 slov; 1–2 odstavce | Žádné | Tělo shortcode | |
inlineLink | URL plus kotva | Ne | 0–1 odkaz | Vynecháno | Tělo | |
position | Vztah v dokumentu | Ano | Jedna akce nebo jeden pojmenovaný sled | Bezprostředně před řízenou akcí | Umístění prvku |
Nadpis by měl začínat slovy „Varování:“, pokud regulovaná slovní zásoba nevyžaduje jiné výslovné slovo pro závažnost. Tělo může spojit riziko a důsledek v jedné větě, ale všechny tři úkoly musí zůstat identifikovatelné. Odkaz může vést na podrobné zásady nebo pokyny k nápravě; nemůže nahradit okamžitý bezpečný postup.
Syntaxe a příklady kódu
Všechna tři mapování nesou stejný typ, nadpis a tělo. Přenosná direktiva je kanonická podoba vytvořená autorem. Hugo používá existující shortcode callout. WordPress může implementovat stejnou smlouvu jako registrovaný blok; forma shortcode je přijatelná pouze tam, kde je v dané instalaci zaregistrován.
Přenosná Markdown direktiva
:::warning{title="Warning: před smazáním exportujte záznamy"}
Smazáním pracovního prostoru nenávratně odstraníte jeho uložené sestavy. Exportujte záznamy, které si potřebujete ponechat, a před potvrzením smazání ověřte název pracovního prostoru.
:::
Hugo shortcode
{{< callout type="important" title="Warning: před smazáním exportujte záznamy" >}}Smazáním pracovního prostoru nenávratně odstraníte jeho uložené sestavy. Exportujte záznamy, které si potřebujete ponechat, a před potvrzením smazání ověřte název pracovního prostoru.{{< /callout >}}
Používejte pojmenované parametry společně. Nemíchejte poziční hodnotu important s pojmenovaným parametrem title.
WordPress blok nebo shortcode
<!-- wp:amicited/warning {"title":"Warning: před smazáním exportujte záznamy"} -->
<p>Smazáním pracovního prostoru nenávratně odstraníte jeho uložené sestavy. Exportujte záznamy, které si potřebujete ponechat, a před potvrzením smazání ověřte název pracovního prostoru.</p>
<!-- /wp:amicited/warning -->
[warning title="Warning: před smazáním exportujte záznamy"]Smazáním pracovního prostoru nenávratně odstraníte jeho uložené sestavy. Exportujte záznamy, které si potřebujete ponechat, a před potvrzením smazání ověřte název pracovního prostoru.[/warning]
Prezentace se může v různých systémech lišit, ale textová závažnost, riziko, důsledek, postup a umístění před akcí musí přežít konverzi.
Příklady
Dobře: placené přepracování s rizikem přepsání
Tento příklad pojmenovává dvě konkrétní rizika, uvádí oba důsledky a poskytuje postupy, které jim předcházejí. Jeho tón je věcný: netvrdí, že účet bude zničen nebo že data budou neobnovitelná, pokud zachovaný export poskytuje cestu k obnově.
Špatně: riziko bez vedení
Špatný příklad neidentifikuje operaci, nepopisuje věrohodný důsledek ani neříká čtenáři, jak bezpečně postupovat. „Vážné“ je nepodložené tvrzení o závažnosti, zatímco „na vlastní riziko“ přesouvá odpovědnost místo vedení chování. Nahraďte to přesnou změnou stavu, tím, co může být ztraceno nebo porušeno, a kontrolou, zálohou, schválením, alternativou nebo podmínkou zastavení požadovanou před akcí.
Dalším selháním je přehnaný alarmismus: „Nikdy se tohoto nastavení nedotýkejte, jinak by celý váš web mohl být zničen!“ I když na nastavení záleží, formulace není ohraničena pravděpodobným výsledkem a neposkytuje žádnou bezpečnou cestu. Čtenáři, kteří zjistí, že tvrzení je přehnané, budou pozdější varování zlevňovat.
Právní a regulovaný obsah
Vyloučení odpovědnosti a varování plní různé úkoly. Vyloučení odpovědnosti vymezuje rozsah, kvalifikace, nejistotu, profesní postavení nebo hranice odpovědnosti. Varování identifikuje předvídatelné riziko v rozhodovacím bodě a mění to, co má čtenář dále dělat. Jedno nemůže nahradit druhé.
U právních, finančních, zdravotních, bezpečnostních, soukromí nebo jiných regulovaných materiálů ponechte schválené vyloučení odpovědnosti na jeho požadovaném místě na stránce a přidejte varování před každou konkrétní akcí, která by mohla vytvořit riziko. Například obecné prohlášení, že článek je vzdělávací, neodstraňuje potřebu varovat před instruováním čtenáře, aby vysadil předepsanou léčbu, převedl regulovaná data, publikoval tvrzení bez schválení nebo přijal opakovaný poplatek.
Autoři nesmí improvizovat právní závěry uvnitř varování. Používejte formulace schválené příslušným odborníkem na danou problematiku nebo pracovníkem pro shodu s předpisy, zachovejte požadovanou terminologii a uveďte operativní postup, který čtenář skutečně může provést: pozastavit se, získat souhlas, uchovat záznamy, poradit se s kvalifikovaným odborníkem, použít schválený kanál nebo předložit k posouzení. Vágní odkaz „prostudujte si podmínky“ je nedostatečný, pokud stránka může uvést okamžitou podmínku zastavení.
Schema markup a přístupnost
Varovný rámeček nemá vyhrazenou vlastnost Schema markup
a neměl by vytvářet samostatný objekt JSON-LD
. Zůstává viditelným obsahem v rámci obalujícího článku. Pokud kvalifikuje strukturovaný postup, může být jeho plný text zahrnut do viditelné instrukce příslušného kroku a odpovídajícího HowToStep.text; nesmí se stát falešným krokem nebo existovat pouze ve strukturovaných datech.
Role ARIA (Accessible Rich Internet Applications) sdělují chování rozhraní asistenčním technologiím, pokud nativní HTML neposkytuje. Statická varování přítomná při načtení stránky by měla zůstat v běžném pořadí dokumentu a nepotřebují role="alert". Role alert způsobuje okamžité ohlášení a je vhodná pouze tehdy, když se naléhavé varování dynamicky objeví po interakci. Použití na každé statické upozornění může přerušit uživatele čteček obrazovky a způsobit, že běžný vstup na stránku bude hlučný. Současný Hugo renderer vydává označený <div> bez role ARIA, což je pro statický blok přijatelné, pokud jeho text a umístění nesou význam.
Barevná nezávislost znamená, že varování zůstává rozpoznatelné v monochromatickém režimu, režimu vysokého kontrastu, textovém exportu a výstupu čtečky obrazovky. Použijte explicitní nadpis „Varování:“ a popište závažnost slovy: „nenávratně maže“, „spouští opakovaný poplatek“, „může odhalit osobní údaje“ nebo „vyžaduje lékařskou péči“. Nepište „vyhněte se červené možnosti“ ani nespoléhejte na alternativní text ikony, který by měl riziko sdělovat.
Udržujte nadpis a tělo v pořadí čtení před řízenou akcí. Odkazy potřebují popisný text kotvy, přístup z klávesnice nesmí záviset na rámečku a nezbytné instrukce se nesmí objevit pouze na snímku obrazovky. Pokud budoucí interaktivní komponenta umožní zavření, zavření nesmí skrýt povinné varování, pokud je akce stále dostupná.
Pravidla psaní
Napište jedno konkrétní varování v rozsahu 25–90 slov a maximálně do dvou krátkých odstavců. Použijte nadpis o 3–9 slovech, obvykle začínající „Varování:“. Pojmenujte spouštěcí akci nebo podmínku, věrohodný důsledek a bezpečnou reakci. Uveďte důvod před pravidlem: čtenáři spolehlivěji vyhoví, když chápou, čemu pravidlo zabraňuje.
Používejte přiměřená slovesa. „Nenávratně maže“, „přepisuje“, „účtuje“, „odhaluje“, „ruší platnost“ a „může způsobit“ popisují mechanismy nebo výsledky. „Ničí“, „katastrofální“, „děsivý“ a „katastrofický“ obvykle dramatizují místo specifikace. Upřímně uveďte nejistotu, pokud výsledek závisí na kontextu, a nikdy nezaručujte bezpečnost jen proto, že čtenář dodrží jedno opatření.
Použijte jeden rozhodovací bod na rámeček. Krátký seznam je přijatelný pouze tehdy, když musí všechny kontroly proběhnout před onou jedinou akcí; jinak použijte souvislý text. Do varování neumísťujte propagační texty, výhody, reference, vtipy, dekorativní emotikony, nesouvisející tipy, celý postup, srovnávací tabulku, několik nadpisů ani výzvu k akci. Neukrývejte požadované instrukce za odkaz.
Nikdy nepoužívejte rámeček k podpoře nepodloženého tvrzení, zastrašování čtenáře k nákupu nebo vytváření umělé naléhavosti. Pokud je akce požadována, ponechte ji v hlavním postupu a zároveň uveďte preventivní krok ve varování. Rámeček mění pozornost; nenahrazuje provozní strukturu dokumentu.
Typy příspěvků, které jej používají
Frontmatter postTypes zaznamenává registrované formáty, ve kterých jsou spouštěče varování předvídatelné. V každém řádku „povinné“ znamená, že autor nemá volbu, jakmile se uvedený spouštěč objeví; prvek nelze odstranit ani zkrátit pod riziko, důsledek a postup kvůli splnění cílové délky.
| Typ příspěvku | Povinný spouštěč | Požadované umístění |
|---|---|---|
| ultimátní průvodce | Průvodce obsahuje instrukce týkající se bezpečnosti, zdraví, práva, compliance, placených služeb, destruktivních operací nebo nakládání s daty. | Před první rizikovou instrukcí v každé samostatně proveditelné sekci. |
| návod | Jakýkoli krok je nenávratný, může ztratit nebo odhalit data, spouští náklady, vytváří regulatorní riziko nebo nese riziko pro bezpečnost či zdraví. | Po příslušných předpokladech a bezprostředně před dotčeným krokem nebo sledem. |
| stránka typu co-je | Vysvětlení zahrnuje rady, podle kterých by čtenář mohl jednat v regulovaném, lékařském, bezpečnostně citlivém nebo právně významném kontextu. | Před prvním proveditelným doporučením, nikoli uvnitř definice. |
| produktová stránka | Ovládací prvek, nákup, zrušení, migrace, smazání, integrace nebo použití dat má materiální náklady nebo nenávratný důsledek, který není zřejmý z jeho popisku. | Vedle a před příslušnou akcí nebo rozhodnutím; nikdy pouze v patičkových podmínkách. |
| kategoriální stránka | Rady při výběru by mohly vytvořit důsledek pro kompatibilitu, celkové náklady, bezpečnost, zdraví, právo nebo compliance. | Před doporučením nebo volbou filtru, která čtenáře vystavuje riziku. |
| stránka případu užití | Propagovaný pracovní postup zpracovává regulovaná data, automatizuje důsledkové rozhodnutí, vyžaduje náklady nebo může vést k nenávratným či nebezpečným výsledkům. | Před fází pracovního postupu nebo akcí produktu, která zavádí riziko. |
Jiné typy příspěvků mohou varování použít, kdykoli se objeví stejné spouštěče. Tabulka definuje opakující se, nepovinné případy; neuděluje výjimku formátům vynechaným z postTypes.
Kontrolní seznam QA
Před publikací ověřte všechny následující body:
- Rámeček pojmenovává jednu konkrétní akci, podmínku nebo rozhodnutí, které vytváří riziko.
- Důsledek uvádí, co se může stát a koho nebo co ovlivňuje, bez nadsázky.
- Postup říká čtenáři, jak se riziku vyhnout, snížit ho, ověřit, zastavit nebo eskalovat.
- Varování se objevuje před první řízenou akcí a jasně pojmenovává svůj rozsah.
- Žádný tip, propagační banner ani druhé varování s ním přímo nesoutěží.
- Povinný spouštěč nebyl vynechán nebo zkrácen kvůli rozvržení nebo počtu slov.
- Je přítomen typ
importanta konkrétní textový varovný nadpis. - Závažnost zůstává jasná i bez barev, ikon, obrázků nebo okolního kontextu.
- Statické varování nepoužívá zbytečnou roli alert; dynamické urgentní varování je vhodně ohlášeno.
- Jakékoli vyloučení odpovědnosti zůstává oddělené a nenahrazuje pokyny v místě akce.
- Regulované formulace a požadovaná terminologie mají odpovídající schválení odborníkem.
- Mapování v Markdown, Hugo a WordPress zachovává stejný nadpis, tělo a umístění.
- Tělo zůstává v rozmezí 25–90 slov, neobsahuje marketingový jazyk a používá nejvýše jeden nezbytný odkaz.
- Komentáře k obrázkům uvádějí pouze požadované budoucí snímky; nevykresluje se žádná neexistující cesta k obrázku.
FAQ
Co musí každý varovný rámeček obsahovat? Konkrétní riziko, jeho věrohodný důsledek a bezpečný postup – všechny tři musí být přítomny. Prvek je bez kteréhokoli z nich neúplný.
Může se varovný rámeček objevit až po rizikové akci? Ne. Musí se objevit dříve, než čtenář může jednat, i když to vyžaduje restrukturalizaci okolních kroků.
Nahrazuje právní vyloučení odpovědnosti varovný rámeček? Ne. Vyloučení odpovědnosti definuje rozsah nebo omezení; varování mění chování v konkrétním rozhodovacím bodě. Regulované stránky mohou vyžadovat obojí.
Má varovný rámeček používat roli alert? Ne, pokud je již přítomen při načtení stránky. Roli alert vyhraďte pro urgentní informace zavedené dynamicky po interakci.
Kolik varovných rámečků může stránka obsahovat? Použijte jeden na každý samostatný rozhodovací bod a slučte varování se stejným cílem. Pokud varování dominují stránce, restrukturalizujte postup nebo zvažte, zda by akce měla být vůbec nabízena.
Varovný rámeček si zaslouží svou vizuální výraznost pouze tehdy, když zabraňuje konkrétní újmě. Uveďte riziko, důsledek a postup klidně, umístěte je před rozhodnutí a zachovejte tento význam v každém výstupu.
Další návody v této sekci
Připraveni uvést to do praxe?
Bezplatná kontrola · 7denní zkušební verze · bez platební karty