Varovací box: Kedy a ako ho používať

Varovací box zastaví čitateľa pred úkonom, ktorý by mohol spôsobiť materiálnu ujmu. Nejde o všeobecný štýl zvýraznenia. Publikovateľné varovanie uvádza riziko, dôsledok a postup, ktorý zabráni alebo obmedzí škodu.

Tento prvok funguje, pretože identifikuje, čo sa môže pokaziť, vysvetľuje, čo bude stratené, a poskytuje bezpečný postup pred deštruktívnym ovládacím prvkom. „Buďte opatrní pri mazaní" by nestačilo: presúva posúdenie rizika späť na čitateľa bez toho, aby mu povedalo, čo znamená byť opatrný.

Prečo je tento prvok dôležitý

Varovania existujú na to, aby zmenili rozhodnutie skôr, než dôjde k ujme. Čitateľ, ktorý nasleduje inštrukcie, sa zvyčajne sústreďuje na dosiahnutie sľúbeného výsledku, preto môže preskakovať upozornenia, ktoré vyzerajú ako bežný kontext. Jasne ohraničené varovanie preruší túto zotrvačnosť v bode, kde má čitateľ ešte na výber. Vytvára zámernú pauzu, vysvetľuje, prečo je pauza dôležitá, a ponúka bezpečný ďalší krok.

Tento prvok slúži psychológii čitateľa len vtedy, keď ho autori používajú selektívne. Ak bežná rada, menšia nepríjemnosť a nezvratná strata dostanú rovnaké zaobchádzanie, čitatelia sa naučia, že vizuálny signál je zriedka dôležitý. Začnú ho preskakovať. Prehnané používanie preto vytvára presne ten typ zlyhania, ktorému má varovanie zabrániť: dôležitá správa je ignorovaná vtedy, keď sú skutočné stávky vysoké. Tón musí informovať, nie strašiť.

Strojová extrahovateľnosť znamená, že softvér dokáže izolovať varovanie a zachovať jeho význam mimo okolitých odsekov. Typovaný blok s textovým varovacím štítkom a samostatne stojacim telom je ľahšie identifikovateľný ako červená veta skrytá vo vnútri kroku. Štruktúra riziko–dôsledok–postup tiež prežije zmeny prezentácie. Automatizovaný publikačný systém môže presúvať obsah medzi Markdown, Hugo a WordPress bez toho, aby musel odvodzovať, ktorá veta popisuje škodu alebo čo má čitateľ urobiť.

Pri mapovaní prvku postupujte podľa pravidiel písania prvkov . Farba, ikona, tučný text alebo nadpis pomenovaný „Dôležité" samy osebe nevytvárajú sémantiku varovania. Slová musia zostať úplné, keď sú skopírované ako obyčajný text alebo čítané bez vizuálneho stylovania stránky.

Kedy ho používať

Varovanie použite vtedy, keď sa čitateľ chystá urobiť voľbu alebo vykonať úkon s predvídateľným materiálnym dôsledkom. Prvok je povinný, ak obsah pokrýva niektorú z týchto spúšťačov:

• Nezvratný úkon: zmazanie, prepísanie, publikovanie, odoslanie, zrušenie účtu alebo iný úkon, ktorý nemožno spoľahlivo vrátiť späť.
• Strata alebo odhalenie údajov: záznamy môžu byť vymazané, poškodené, zverejnené, prenesené alebo zneprístupnené.
• Finančný dôsledok: úkon spúšťa poplatok, obnovuje záväzok, spotrebúva platený limit alebo vytvára náklady, ktoré nie sú zrejmé v bode rozhodnutia.
• Bezpečnostné alebo zdravotné riziko: nasledovanie, kombinovanie alebo vynechanie pokynu by mohlo spôsobiť zranenie, chorobu alebo oneskorenú starostlivosť.
• Právne alebo regulačné riziko: úkon by mohol porušiť zákon, zmluvu, politiku, licenciu, pravidlá uchovávania, súhlasné požiadavky alebo regulovaný schvaľovací proces.

O zaradení rozhoduje spúšťač, nie preferencia autora alebo dostupný počet slov. Ak sa jeden spúšťač vzťahuje, varovanie nemožno skrátiť na vágny štítok, presunúť do všeobecného vyhlásenia alebo vynechať kvôli šablóne. Najprv skráťte okolité vysvetlenie.

Nepoužívajte varovanie pre užitočnú skratku, osvedčený postup, definíciu, miernu nepríjemnosť, bežný predpoklad alebo reverzibilnú chybu so zrejmým riešením. Toto sú takmer zásahy, pretože môžu byť „dôležité" v bežnom jazyku, ale nevyžadujú zastavenie rozhodnutia. Požadované predpoklady uveďte v postupe, voliteľné vylepšenia v boxe s tipmi a bežné riešenie chýb vedľa kroku, ktorý opravuje.

Nepoužívajte varovanie len preto, že výsledok je nežiaduci. „Nízka kvalita titulkov môže znížiť kliknutia" je vysvetlenie výkonu, nie varovanie. Stáva sa varovacím materiálom len vtedy, keď blízky úkon vytvára konkrétny, materiálny dôsledok: napríklad zmena URL štruktúry živej stránky bez presmerovaní môže zlomiť prichádzajúce odkazy a odstrániť indexované ciele. V takom prípade uveďte preventívny postup pred zmenou.

Kde ho umiestniť

Varovanie patrí bezprostredne pred najskorší úkon, ktorého sa týka. „Úkon" zahŕňa číslovaný pokyn, príkaz, odoslanie formulára, nákupný ovládací prvok, stiahnutie, odporúčanie alebo rozhodnutie, podľa ktorého môže čitateľ konať. Box umiestnite po dostatočnom kontexte na identifikáciu situácie, ale pred prvý vykonateľný pokyn. Nikdy neodhaľujte riziko po úkone, v poznámkach pod čiarou alebo len v záverečných FAQ.

Ak jedno varovanie riadi celý sled, umiestnite ho pred sled a pomenujte jeho rozsah: „Nasledujúce tri kroky nahrádzajú produkčnú databázu." Neopakujte rovnaké varovanie v každom kroku. Ak neskorší krok prináša iné riziko, pridajte druhé varovanie bezprostredne pred tento krok.

Varovanie nesmie sedieť priamo vedľa iného upozornenia, propagačnej výzvy na akciu alebo dekoratívneho banneru. Susediace boxy si konkurujú o pozornosť a môžu spôsobiť, že varovanie bude vyzerať ako súčasť marketingového balíka. Nesmie oddeľovať pokyn od jeho požadovaného vstupu, tvrdenie od jeho dôkazu alebo názov tabuľky od samotnej tabuľky. Pridajte obyčajný prechod alebo reštrukturalizujte sekciu tak, aby varovanie jasne kvalifikovalo jedno rozhodnutie.

Právne formuláre umiestnite podľa príslušnej politiky, ale operačné varovanie ponechajte vedľa rizikového úkonu. Presun varovania do pätičky len preto, že už existuje vyhlásenie, popiera jeho účel.

Anatómia

Vykreslený prvok má šesť sémantických oblastí:

1. Štítok závažnosti: viditeľný text, ktorý hovorí, že ide o varovanie; nemožno ho sprostredkovať iba farbou alebo ikonou.
2. Konkrétny názov: pomenúva rozhodnutie alebo riziko, napríklad „Varovanie: exportujte záznamy pred zmazaním."
3. Riziko: uvádza, aký úkon alebo podmienka sa môže pokaziť.
4. Dôsledok: uvádza dôveryhodný výsledok a koho alebo čo ovplyvňuje.
5. Postup: hovorí čitateľovi, ako sa vyhnúť riziku, znížiť ho, overiť ho alebo eskalovať pred pokračovaním.
6. Vzťahová pozícia: prepája varovanie s nasledujúcim úkonom, ktorý riadi.

Legenda zostáva ako živý text stránky, nie je vložená do obrázku. To zabezpečuje, že každý štítok je dostupný pre asistenčné technológie a umožňuje zmenu dizajnu bez toho, aby sa špecifikácia stala nepresnou.

Príklady dizajnu

Súčasná knižnica podporuje jednu závažnosť varovania: Hugo ho vykresľuje pomocou type="important". Neexistuje samostatný variant pre upozornenie, varovanie, nebezpečenstvo, kritické alebo núdzové. Táto zámerná jednoduchosť zabezpečuje konzistentnosť autorovej voľby a znižuje pravdepodobnosť, že dvaja autori priradia rôzne farby rovnakému dôsledku. Kompromisom je, že komponent nedokáže vizuálne rozlíšiť nahraditeľnú finančnú stratu od bezprostredného fyzického nebezpečenstva. Autori musia uviesť závažnosť v názve a dôsledku namiesto spoliehania sa na silnejšiu farbu.

Galéria preto testuje jednu závažnosť v rámci podporovaných obsahových variácií: predvolený štítok, konkrétny vlastný názov, maximálne dva odseky a úzke zobrazenie. Ide o prípady vykreslenia, nie rôzne úrovne závažnosti.

Nevymýšľajte si závažnosť pridaním emotikonov, VEĽKÝCH PÍSMEN, opakovaných výkričníkov, vlastných tried alebo nepodporovaných hodnôt typu. Ak knižnica neskôr získa viac úrovní, ich hranice musia byť založené na dôsledku a požadovanej reakcii, nie na tom, ako silno autor cíti o danom odseku.

Parametre

Renderer má len vstupy type, title a body. Riziko, dôsledok a postup sú editorské polia vnútri tela; ich explicitné uvedenie v tejto zmluve zabraňuje tomu, aby vizuálne platné upozornenie publikovalo neúplné usmernenie.

Názov by mal začínať slovom „Varovanie:" pokiaľ regulovaný slovník nevyžaduje iné explicitné slovo závažnosti. Telo môže kombinovať riziko a dôsledok v jednej vete, ale všetky tri úlohy musia zostať identifikovateľné. Odkaz môže smerovať na podrobné pokyny politiky alebo obnovy; nemôže nahradiť okamžitý bezpečný postup.

Syntax a príklady kódu

Všetky tri mapovania nesú rovnaký typ, názov a telo. Prenosná direktíva je kanonická podoba vytvorená autorom. Hugo používa existujúci shortcode callout. WordPress môže implementovať rovnakú zmluvu ako registrovaný blok; formát shortcode je prijateľný len tam, kde ho daná inštalácia zaregistrovala.

Prenosná Markdown direktíva

:::warning{title="Warning: export records before deletion"}
Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.
:::

Hugo shortcode

{{< callout type="important" title="Warning: export records before deletion" >}}Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.{{< /callout >}}

Používajte pomenované parametre spoločne. Nekombinujte pozičnú hodnotu important s pomenovaným parametrom title.

WordPress blok alebo shortcode

<!-- wp:amicited/warning {"title":"Warning: export records before deletion"} -->
<p>Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.</p>
<!-- /wp:amicited/warning -->

[warning title="Warning: export records before deletion"]Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.[/warning]

Prezentácia sa môže líšiť medzi systémami, ale textová závažnosť, riziko, dôsledok, postup a pred-akčná pozícia musia prežiť konverziu.

Príklady

Dobrý: platené spracovanie s rizikom prepísania

Tento príklad uvádza dve konkrétne riziká, uvádza oba dôsledky a poskytuje postupy, ktorým predchádza. Jeho tón je faktografický: netvrdí, že účet bude zničený alebo dáta budú neobnoviteľné, ak zachovaný export poskytuje cestu obnovy.

Zlý: riziko bez usmernenia

Zlý príklad neidentifikuje operáciu, nepopisuje dôveryhodný dôsledok ani nehovorí čitateľovi, ako bezpečne pokračovať. „Závažné" je nepodložené tvrdenie o závažnosti, zatiaľ čo „na vlastné riziko" presúva zodpovednosť namiesto usmernenia správania. Nahraďte ho presnou zmenou stavu, tým, čo môže byť stratené alebo porušené, a kontrolou, zálohou, schválením, alternatívou alebo podmienkou zastavenia požadovanou pred úkonom.

Ďalším zlyhaním je prílišná alarmizácia: „Nikdy sa tohto nastavenia nedotýkajte, inak by mohla byť celá vaša stránka zničená!" Aj keď na nastavení záleží, formulácia nie je ohraničená pravdepodobným výsledkom a neposkytuje bezpečnú cestu. Čitatelia, ktorí zistia, že tvrdenie je prehnané, budú neskoršie varovania ignorovať.

Právny a regulovaný obsah

Vyhlásenie a varovanie plnia rôzne úlohy. Vyhlásenie definuje rozsah, kvalifikácie, neistotu, profesionálny status alebo hranice zodpovednosti. Varovanie identifikuje predvídateľné riziko v bode rozhodnutia a mení to, čo by mal čitateľ urobiť ďalej. Jedno nemôže nahradiť druhé.

Pre právny, finančný, zdravotný, bezpečnostný, súkromný alebo iný regulovaný materiál ponechajte schválené vyhlásenie na požadovanom mieste stránky a pridajte varovanie pred každým konkrétnym úkonom, ktorý by mohol vytvoriť riziko. Napríklad všeobecné vyhlásenie, že článok je vzdelávací, neodstraňuje potrebu varovať pred pokynom čitateľovi, aby prestal užívať predpísanú liečbu, preniesol regulované údaje, publikoval tvrdenie bez schválenia alebo akceptoval opakujúci sa poplatok.

Autori nesmú improvizovať právne závery vnútri varovania. Používajte formulácie schválené príslušným odborníkom na danú tému alebo compliance recenzentom, zachovajte požadovanú terminológiu a uveďte operačný postup, ktorý môže čitateľ skutočne vykonať: pozastaviť, získať súhlas, uchovať záznamy, poradiť sa s kvalifikovaným odborníkom, použiť schválený kanál alebo eskalovať na posúdenie. Vágny odkaz „pozrite si podmienky" je nedostatočný, keď stránka môže uviesť okamžitú podmienku zastavenia.

Schema markup a prístupnosť

Varovací box nemá vyhradenú vlastnosť Schema markup a nemal by vytvárať samostatný objekt JSON-LD . Zostáva viditeľným obsahom v rámci uzatvárajúceho článku. Ak kvalifikuje štruktúrovaný postup, jeho plný text môže byť zahrnutý do viditeľného pokynu príslušného kroku a zodpovedajúceho HowToStep.text; nesmie sa stať falošným krokom alebo existovať len v štruktúrovaných dátach.

ARIA (Accessible Rich Internet Applications) roly komunikujú správanie rozhrania asistenčným technológiám, keď natívne HTML neposkytuje túto informáciu. Statické varovania prítomné pri načítaní stránky by mali zostať v normálnom poradí dokumentu a nepotrebujú role="alert". Rola alert spôsobuje okamžité ohlásenie a je vhodná len vtedy, keď sa naliehavé varovanie objaví dynamicky po interakcii. Aplikovanie na každé statické upozornenie môže prerušiť používateľov čítačiek obrazovky a spôsobiť, že bežný vstup na stránku bude hlučný. Súčasný Hugo renderer vypisuje označený <div> bez ARIA roly, čo je prijateľné pre statický blok, keď jeho text a umiestnenie nesú význam.

Farebná nezávislosť znamená, že varovanie zostáva rozpoznateľné v monochrómnom režime, režime vysokého kontrastu, textovom exporte a výstupe čítačky obrazovky. Používajte explicitný názov „Varovanie:" a popíšte závažnosť slovami: „natrvalo maže", „spúšťa opakujúci sa poplatok", „môže odhaliť osobné údaje" alebo „vyžaduje lekársku starostlivosť". Nepíšte „vyhnite sa červenej možnosti" ani sa nespoliehajte na alternatívny text ikony, ktorý by mal poskytnúť informáciu o riziku.

Názov a telo ponechajte v poradí čítania pred riadeným úkonom. Odkazy potrebujú deskriptívny kotviaci text, prístup cez klávesnicu nesmie závisieť od upozornenia a dôležité pokyny sa nemôžu nachádzať len na snímke obrazovky. Ak budúci interaktívny komponent umožňuje zatvorenie, zatvorenie nesmie skryť povinné varovanie, kým je úkon naďalej dostupný.

Pravidlá písania

Napíšte jedno konkrétne varovanie v rozsahu 25–90 slov a najviac dvoch krátkych odsekov. Použite názov s 3–9 slovami, bežne začínajúci slovom „Varovanie:". Uveďte spúšťajúci úkon alebo podmienku, dôveryhodný dôsledok a bezpečnú reakciu. Dôvod uveďte pred pravidlom: čitatelia spoľahlivejšie dodržiavajú pravidlá, keď rozumejú, čomu pravidlo predchádza.

Používajte proporcionálne slovesá. „Natrvalo maže", „prepisuje", „účtuje", „odhaľuje", „zneplatňuje" a „môže spôsobiť" popisujú mechanizmy alebo výsledky. „Ničí", „katastrofálny", „desivý" a „katastrofický" zvyčajne dramatizujú namiesto špecifikácie. Neistotu uveďte čestne, keď výsledok závisí od kontextu, a nikdy nezaručujte bezpečnosť len preto, že čitateľ dodrží jedno preventívne opatrenie.

Zachovajte jeden rozhodovací bod na box. Krátky zoznam je prijateľný len vtedy, keď niekoľko kontrol musí všetky nastať pred týmto jedným úkonom; inak používajte prózu. Do varovania nevkladajte propagačný text, výhody, referencie, vtipy, dekoratívne emotikony, nesúvisiace tipy, celý postup, porovnávaciu tabuľku, viacero nadpisov ani výzvu na akciu. Požadované pokyny neschovávajte za odkaz.

Nikdy nepoužívajte box na ochranu nepodloženého tvrdenia, zastrašenie čitateľa, aby si kúpil, alebo na vytvorenie umelej naliehavosti. Ak je úkon povinný, ponechajte ho v hlavnom postupe a zároveň uveďte preventívny krok vo varovaní. Box mení pozornosť; nenahrádza operačnú štruktúru dokumentu.

Typy príspevkov, ktoré ho používajú

Frontmatter postTypes zaznamenáva registrované formáty, v ktorých sú spúšťače varovania predvídateľné. V každom riadku „povinné" znamená, že autor nemá diskréciu, keď sa uvedený spúšťač objaví; prvok nemožno odstrániť alebo skomprimovať pod riziko, dôsledok a postup kvôli splneniu cieľovej dĺžky.

Iné typy príspevkov môžu použiť varovanie vždy, keď sa objavia rovnaké spúšťače. Tabuľka definuje opakujúce sa, nevoliteľné prípady; neposkytuje výnimku pre formáty vynechané z postTypes.

Kontrolný zoznam QA

Pred publikovaním overte všetky nasledujúce body:

• Box pomenúva jeden konkrétny úkon, podmienku alebo rozhodnutie, ktoré vytvára riziko.
• Dôsledok uvádza, čo sa môže stať a koho alebo čo ovplyvňuje, bez preháňania.
• Postup hovorí čitateľovi, ako sa riziku vyhnúť, znížiť ho, overiť, zastaviť alebo eskalovať.
• Varovanie sa objavuje pred prvým riadeným úkonom a jasne pomenúva svoj rozsah.
• Žiadny tip, promo, banner ani druhé varovanie s ním priamo nesúťaží.
• Povinný spúšťač nebol vynechaný alebo skrátený kvôli rozloženiu alebo počtu slov.
• Typ important a konkrétny textový varovací názov sú prítomné.
• Závažnosť zostáva zrejmá bez farby, ikon, obrázkov alebo okolitého kontextu.
• Statické varovanie nepoužíva zbytočnú rolu alert; dynamické naliehavé varovanie je vhodne ohlásené.
• Všetky vyhlásenia zostávajú oddelené a nenahrádzajú usmernenie v bode konania.
• Regulované formulácie a požadovaná terminológia majú schválenie príslušného odborníka na danú tému.
• Mapovania v Markdown, Hugo a WordPress zachovávajú rovnaký názov, telo a pozíciu.
• Telo zostáva v rozmedzí 25–90 slov, neobsahuje marketingový jazyk a používa najviac jeden nevyhnutný odkaz.
• Komentáre k snímkam obrazovky uvádzajú len požadované budúce zachytenia; žiadna neexistujúca cesta k obrázku nie je vykreslená.

FAQ

Čo musí obsahovať každý varovací box? Konkrétne riziko, jeho dôveryhodný dôsledok a bezpečný postup musia byť všetky prítomné. Prvok je neúplný bez ktoréhokoľvek z nich.

Môže sa varovací box nachádzať až po rizikovom úkone? Nie. Musí sa objaviť skôr, než čitateľ môže konať, aj keď si to vyžaduje reštrukturalizáciu okolitých krokov.

Nahrádza právne vyhlásenie varovací box? Nie. Vyhlásenie definuje rozsah alebo obmedzenia; varovanie mení správanie v konkrétnom rozhodovacom bode. Regulované stránky môžu vyžadovať oboje.

Mal by varovací box používať rolu alert? Nie, ak je už prítomný pri načítaní stránky. Rolu alert si vyhraďte pre naliehavé informácie zavedené dynamicky po interakcii.

Koľko varovacích boxov môže stránka obsahovať? Použite jeden pre každý samostatný rozhodovací bod a zlúčte varovania s rovnakým cieľom. Ak varovania dominujú stránke, reštrukturalizujte postup alebo zvážte, či by sa úkon mal vôbec ponúkať.

Varovací box si zaslúži svoju vizuálnu výraznosť len vtedy, keď predchádza konkrétnej škode. Uveďte riziko, dôsledok a postup pokojne, umiestnite ich pred rozhodnutie a zachovajte tento význam v každom výstupe.