Warning Box: Kiedy i jak go używać

Warning box zatrzymuje czytelnika przed działaniem, które może spowodować materialną szkodę. Nie jest to ogólny styl wyróżnienia. Publikowalne ostrzeżenie określa ryzyko, konsekwencję oraz działanie, które pozwala uniknąć lub ograniczyć szkodę.

Ten działający element pokazuje, co może pójść nie tak, wyjaśnia, co zostanie utracone, i podaje bezpieczną sekwencję przed destrukcyjną kontrolką. „Bądź ostrożny podczas usuwania” nie byłoby wystarczające: przenosi ocenę ryzyka z powrotem na czytelnika, nie mówiąc mu, co oznacza ostrożne zachowanie.

Dlaczego ten element ma znaczenie

Ostrzeżenia istnieją po to, by zmienić decyzję, zanim nastąpi szkoda. Czytelnik podążający za instrukcjami zwykle koncentruje się na osiągnięciu obiecanego rezultatu, przez co może przelatywać wzrokiem przez zastrzeżenia wyglądające jak zwykłe tło. Wyraźnie oznaczony warning box przerywa ten pęd w momencie, gdy czytelnik wciąż ma wybór. Tworzy celową pauzę, wyjaśnia, dlaczego ta pauza ma znaczenie, i dostarcza bezpieczną następną czynność.

Element ten służy psychologii czytelnika tylko wtedy, gdy autorzy używają go selektywnie. Jeśli rutynowa rada, drobna niedogodność i nieodwracalna strata otrzymują to samo traktowanie, czytelnicy uczą się, że sygnał wizualny rzadko ma znaczenie. Zaczynają go pomijać. Przesada tworzy zatem dokładnie ten tryb awarii, któremu ostrzeżenie ma zapobiegać: ważna wiadomość jest lekceważona, gdy stawka jest realna. Ton musi informować, a nie straszyć.

Możliwość maszynowego wyodrębnienia oznacza, że oprogramowanie może wyizolować ostrzeżenie i zachować jego znaczenie poza otaczającymi akapitami. Typowany blok z tekstową etykietą ostrzeżenia i samodzielną treścią jest łatwiejszy do zidentyfikowania niż czerwone zdanie ukryte wewnątrz kroku. Struktura ryzyko–konsekwencja–działanie przetrwa również zmiany prezentacji. Zautomatyzowany system publikacji może przenosić treść między Markdown, Hugo i WordPress bez konieczności wnioskowania, które zdanie opisuje szkodę ani co czytelnik powinien zrobić.

Postępuj zgodnie z zasadami pisania elementów podczas mapowania elementu. Kolor, ikona, pogrubiony tekst lub nagłówek o nazwie „Ważne” nie tworzą same w sobie semantyki ostrzeżenia. Słowa muszą pozostać kompletne, gdy są kopiowane jako zwykły tekst lub czytane bez wizualnego stylu strony.

Kiedy go używać

Użyj warning boxa, gdy czytelnik ma dokonać wyboru lub wykonać działanie z przewidywalną materialną konsekwencją. Element jest obowiązkowy, gdy treść dotyczy któregokolwiek z tych wyzwalaczy:

• Działanie nieodwracalne: usunięcie, nadpisanie, publikacja, przesłanie, zamknięcie konta lub inne działanie, którego nie można wiarygodnie cofnąć.
• Utrata lub ujawnienie danych: rekordy mogą zostać usunięte, uszkodzone, ujawnione, przeniesione lub udostępnione w sposób uniemożliwiający dostęp.
• Konsekwencje kosztowe: działanie uruchamia opłatę, odnawia zobowiązanie, zużywa płatny limit lub tworzy koszt, który nie jest oczywisty w momencie podejmowania decyzji.
• Ryzyko dla bezpieczeństwa lub zdrowia: zastosowanie się, połączenie lub pominięcie instrukcji może spowodować obrażenia, chorobę lub opóźnioną opiekę.
• Ryzyko prawne lub zgodności: działanie może naruszać prawo, umowę, politykę, licencję, zasady przechowywania, wymóg zgody lub regulowany proces zatwierdzania.

Wyzwalacz, a nie preferencja autora ani dostępna liczba słów, decyduje o włączeniu elementu. Jeśli któryś ma zastosowanie, ostrzeżenia nie można skrócić do niejasnej etykiety, przenieść do ogólnego zastrzeżenia ani pominąć, aby dopasować się do szablonu. Najpierw skróć otaczające wyjaśnienie.

Nie używaj warning boxa do przydatnego skrótu, najlepszej praktyki, definicji, drobnej niedogodności, normalnego wymogu wstępnego ani odwracalnego błędu z oczywistym rozwiązaniem. Są to przypadki graniczne, ponieważ mogą być „ważne” w języku potocznym, ale nie wymagają decyzji o zatrzymaniu. Wymagane wymagania wstępne umieść w procedurze, opcjonalne ulepszenia w tip boxie, a zwykłe odzyskiwanie po błędzie obok kroku, który naprawiają.

Nie ostrzegaj tylko dlatego, że rezultat jest niepożądany. „Niskiej jakości tytuły mogą zmniejszyć liczbę kliknięć” to wyjaśnienie wydajności, a nie ostrzeżenie. Staje się materiałem ostrzegawczym tylko wtedy, gdy pobliskie działanie stwarza konkretną, materialną konsekwencję: na przykład zmiana struktury URL działającej strony bez przekierowań może zepsuć linki przychodzące i usunąć indeksowane miejsca docelowe. W takim przypadku podaj działanie zapobiegawcze przed zmianą.

Gdzie go umieścić

Warning box należy bezpośrednio przed najwcześniejszym działaniem, którego dotyczy. „Działanie” obejmuje ponumerowaną instrukcję, polecenie, przesłanie formularza, kontrolkę zakupu, pobranie, rekomendację lub decyzję, którą czytelnik może podjąć. Umieść warning box po wystarczającym kontekście do identyfikacji sytuacji, ale przed pierwszą wykonywalną instrukcją. Nigdy nie ujawniaj ryzyka po działaniu, w przypisach ani tylko w zamykającym FAQ.

Jeśli jedno ostrzeżenie dotyczy sekwencji kroków, umieść je przed sekwencją i określ jego zakres: „Kolejne trzy kroki zastępują produkcyjną bazę danych.” Nie powtarzaj tego samego ostrzeżenia w każdym kroku. Jeśli późniejszy krok wprowadza inne ryzyko, dodaj drugi warning box bezpośrednio przed tym krokiem.

Warning box nie może znajdować się bezpośrednio obok innego callouta, promocyjnego wezwania do działania ani dekoracyjnego banera. Sąsiadujące boxy konkurują o uwagę i mogą sprawić, że ostrzeżenie będzie wyglądać jak część sterty marketingowej. Nie może oddzielać instrukcji od wymaganego wejścia, twierdzenia od dowodu ani tytułu tabeli od samej tabeli. Dodaj zwykłe przejście lub przebuduj sekcję tak, aby ostrzeżenie wyraźnie kwalifikowało jedną decyzję.

Umieść prawniczy tekst standardowy zgodnie z obowiązującą polityką, ale zachowaj ostrzeżenie operacyjne obok ryzykownego działania. Przeniesienie ostrzeżenia do stopki tylko dlatego, że istnieje już zastrzeżenie, niweczy jego cel.

Anatomia

Wyrenderowany element ma sześć regionów semantycznych:

1. Etykieta powagi: widoczny tekst informujący, że to ostrzeżenie; nie może być przekazany wyłącznie kolorem lub ikoną.
2. Konkretny tytuł: nazywa decyzję lub zagrożenie, np. „Ostrzeżenie: wyeksportuj rekordy przed usunięciem.”
3. Ryzyko: określa, jakie działanie lub warunek może pójść źle.
4. Konsekwencja: określa wiarygodny wynik oraz kogo lub czego dotyczy.
5. Działanie: mówi czytelnikowi, jak uniknąć, zmniejszyć, zweryfikować lub eskalować ryzyko przed kontynuowaniem.
6. Relacja pozycyjna: łączy ostrzeżenie z następnym działaniem, którego dotyczy.

Legenda pozostaje jako żywy tekst na stronie, a nie jest wbudowana w obraz. Dzięki temu każda etykieta jest dostępna dla technologii asystujących, a projekt może się zmieniać bez unieważniania specyfikacji.

Przykłady projektowe

Obecna biblioteka obsługuje jeden poziom powagi ostrzeżenia: Hugo renderuje go za pomocą type="important". Nie ma osobnych wariantów caution, warning, danger, critical ani emergency. Ta celowa prostota zapewnia spójność wyborów autora i zmniejsza ryzyko, że dwóch autorów przypisze różne kolory tej samej konsekwencji. Kompromis polega na tym, że komponent nie może wizualnie odróżnić odzyskiwalnej straty finansowej od bezpośredniego zagrożenia fizycznego. Autorzy muszą określać powagę w tytule i konsekwencji, zamiast polegać na mocniejszym kolorze.

Galeria testuje zatem jeden poziom powagi w obsługiwanych wariantach treści: domyślną etykietę, konkretny niestandardowy tytuł, maksymalnie dwa akapity oraz wąski widok. Są to przypadki renderowania, a nie różne poziomy powagi.

Nie twórz własnych poziomów powagi przez dodawanie emoji, wielkich liter, powtórzonych wykrzykników, niestandardowych klas ani nieobsługiwanych wartości typu. Jeśli biblioteka później zyska wiele poziomów, ich granice muszą być oparte na konsekwencji i wymaganej reakcji, a nie na sile przekonania autora co do danego fragmentu.

Parametry

Renderer ma tylko wejścia type, title i body. Ryzyko, konsekwencja i działanie to pola redakcyjne wewnątrz body; utrzymanie ich jawności w tym kontrakcie zapobiega publikowaniu niekompletnych wskazówek w wizualnie poprawnym calloucie.

Tytuł powinien zaczynać się od „Warning:”, chyba że regulowane słownictwo wymaga innego jawnego słowa określającego powagę. Body może łączyć ryzyko i konsekwencję w jednym zdaniu, ale wszystkie trzy zadania muszą pozostać rozpoznawalne. Link może prowadzić do szczegółowej polityki lub instrukcji odzyskiwania; nie może zastąpić natychmiastowego bezpiecznego działania.

Składnia i przykłady kodu

Wszystkie trzy mapowania niosą ten sam type, title i body. Przenośna dyrektywa jest kanoniczną formą autorską. Hugo używa istniejącego shortcode callout. WordPress może zaimplementować ten sam kontrakt jako zarejestrowany blok; forma shortcode jest akceptowalna tylko tam, gdzie dana instalacja go zarejestrowała.

Przenośna dyrektywa Markdown

:::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.
:::

Shortcode Hugo

{{< 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 >}}

Używaj nazwanych parametrów razem. Nie mieszaj pozycyjnej wartości important z nazwanym parametrem title.

Blok lub shortcode WordPress

<!-- 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]

Prezentacja może różnić się w różnych systemach, ale tekstowa powaga, ryzyko, konsekwencja, działanie i pozycja przed działaniem muszą przetrwać konwersję.

Przykłady

Dobrze: płatne przetwarzanie z ryzykiem nadpisania

Ten przykład wymienia dwa konkretne ryzyka, określa obie konsekwencje i dostarcza działań, które im zapobiegają. Jego ton jest rzeczowy: nie twierdzi, że konto zostanie zrujnowane ani że dane będą nie do odzyskania, jeśli zachowany eksport zapewni ścieżkę odzyskiwania.

Źle: ryzyko bez wskazówek

Zły przykład nie identyfikuje operacji, nie opisuje wiarygodnej konsekwencji ani nie mówi czytelnikowi, jak postępować bezpiecznie. „Poważne” to niepoparte twierdzenie o powadze, a „na własne ryzyko” przenosi odpowiedzialność zamiast kierować zachowaniem. Zastąp to dokładną zmianą stanu, tym, co może zostać utracone lub naruszone, oraz warunkiem sprawdzenia, kopii zapasowej, zatwierdzenia, alternatywy lub zatrzymania wymaganym przed działaniem.

Inną porażką jest nadmierny alarmizm: „Nigdy nie dotykaj tego ustawienia, bo cała strona może zostać zniszczona!” Nawet jeśli ustawienie ma znaczenie, sformułowanie nie jest ograniczone prawdopodobnym rezultatem i nie podaje bezpiecznej drogi. Czytelnicy, którzy odkryją, że twierdzenie jest przesadzone, będą lekceważyć późniejsze ostrzeżenia.

Treści prawne i regulowane

Zastrzeżenie i ostrzeżenie pełnią różne funkcje. Zastrzeżenie określa zakres, kwalifikacje, niepewność, status zawodowy lub granice odpowiedzialności. Ostrzeżenie identyfikuje przewidywalne zagrożenie w punkcie decyzyjnym i zmienia to, co czytelnik powinien zrobić dalej. Jedno nie może zastąpić drugiego.

W przypadku materiałów prawnych, finansowych, zdrowotnych, bezpieczeństwa, prywatności lub innych regulowanych treści zachowaj zatwierdzone zastrzeżenie w wymaganej lokalizacji na stronie i dodaj warning box przed każdym konkretnym działaniem, które może stworzyć ekspozycję. Na przykład ogólne stwierdzenie, że artykuł ma charakter edukacyjny, nie usuwa potrzeby ostrzeżenia przed nakazaniem czytelnikowi odstawienia przepisanego leczenia, przeniesienia regulowanych danych, opublikowania twierdzenia bez zatwierdzenia lub zaakceptowania cyklicznej opłaty.

Autorzy nie mogą improwizować wniosków prawnych wewnątrz warning boxa. Używaj sformułowań zatwierdzonych przez odpowiedzialnego recenzenta merytorycznego lub ds. zgodności, zachowaj wymaganą terminologię i podaj działanie operacyjne, które czytelnik może faktycznie podjąć: wstrzymaj się, uzyskaj zgodę, zachowaj dokumentację, skonsultuj się z wykwalifikowanym specjalistą, użyj zatwierdzonego kanału lub zgłoś do przeglądu. Nieprecyzyjny link „sprawdź regulamin” jest niewystarczający, gdy strona może podać natychmiastowy warunek zatrzymania.

Schema markup i dostępność

Warning box nie ma dedykowanej właściwości Schema markup i nie powinien tworzyć samodzielnego obiektu JSON-LD . Pozostaje widoczną treścią w ramach otaczającego artykułu. Gdy kwalifikuje ustrukturyzowaną procedurę, jego pełny tekst może być zawarty w widocznej instrukcji odpowiedniego kroku i odpowiadającym mu HowToStep.text; nie może stać się fałszywym krokiem ani istnieć tylko w ustrukturyzowanych danych.

Role ARIA komunikują zachowanie interfejsu technologiom asystującym, gdy natywny HTML ich nie zapewnia. Statyczne ostrzeżenia obecne przy ładowaniu strony powinny pozostać w normalnej kolejności dokumentu i nie potrzebują role="alert". Rola alert powoduje natychmiastowe ogłoszenie i jest odpowiednia tylko wtedy, gdy pilne ostrzeżenie pojawia się dynamicznie po interakcji. Zastosowanie jej do każdego statycznego callouta może przerywać użytkownikom czytników ekranu i powodować hałas przy rutynowym wchodzeniu na stronę. Obecny renderer Hugo wypisuje oznaczony <div> bez roli ARIA, co jest akceptowalne dla statycznego bloku, gdy jego tekst i umiejscowienie niosą znaczenie.

Niezależność od koloru oznacza, że warning box pozostaje rozpoznawalny w trybie monochromatycznym, trybie wysokiego kontrastu, eksporcie tylko tekstowym i na wyjściu czytnika ekranu. Używaj jawnego tytułu „Warning:” i opisuj powagę słowami: „trwale usuwa”, „uruchamia cykliczną opłatę”, „może ujawnić dane osobowe” lub „wymaga pomocy medycznej”. Nie pisz „unikaj czerwonej opcji” ani nie polegaj na tekście alternatywnym ikony, aby dostarczyć informacji o zagrożeniu.

Zachowaj tytuł i body w kolejności czytania przed regulowanym działaniem. Linki potrzebują opisowego tekstu zakotwiczenia, dostępność klawiaturowa nie może zależeć od callouta, a niezbędne instrukcje nie mogą pojawiać się tylko na zrzucie ekranu. Jeśli przyszły interaktywny komponent umożliwi odrzucanie, odrzucenie nie może ukrywać obowiązkowego ostrzeżenia, gdy działanie jest nadal dostępne.

Zasady pisania

Napisz jedno konkretne ostrzeżenie w 25–90 słowach i nie więcej niż dwóch krótkich akapitach. Użyj tytułu o długości 3–9 słów, zwykle zaczynającego się od „Warning:”. Nazwij wyzwalające działanie lub warunek, wiarygodną konsekwencję i bezpieczną reakcję. Podaj powód przed regułą: czytelnicy stosują się bardziej niezawodnie, gdy rozumieją, czemu reguła zapobiega.

Używaj proporcjonalnych czasowników. „Trwale usuwa”, „nadpisuje”, „obciąża opłatą”, „ujawnia”, „unieważnia” i „może spowodować” opisują mechanizmy lub skutki. „Niszczy”, „katastrofalny”, „przerażający” i „tragiczny” zwykle dramatyzują zamiast precyzować. Podawaj niepewność uczciwie, gdy wynik zależy od kontekstu, i nigdy nie gwarantuj bezpieczeństwa tylko dlatego, że czytelnik zastosował się do jednego środka ostrożności.

Zachowaj jeden punkt decyzyjny na warning box. Krótka lista jest akceptowalna tylko wtedy, gdy kilka kontroli musi nastąpić przed jednym działaniem; w przeciwnym razie użyj prozy. Nie umieszczaj w warning boxie treści promocyjnych, korzyści, referencji, żartów, dekoracyjnych emoji, niezwiązanych wskazówek, pełnej procedury, tabeli porównawczej, kilku nagłówków ani wezwania do działania. Nie ukrywaj wymaganych instrukcji za linkiem.

Nigdy nie używaj warning boxa do ochrony niepopartego twierdzenia, zastraszania czytelnika w celu dokonania zakupu ani tworzenia sztucznej pilności. Jeśli działanie jest wymagane, zachowaj je w głównej procedurze, oprócz podania kroku zapobiegawczego w warning boxie. Warning box zmienia uwagę; nie zastępuje struktury operacyjnej dokumentu.

Typy postów, które go używają

Frontmatter postTypes rejestruje formaty, w których wyzwalacze ostrzeżeń są przewidywalne. W każdym wierszu „obowiązkowy” oznacza, że autor nie ma uznania po pojawieniu się określonego wyzwalacza; element nie może zostać usunięty ani skompresowany poniżej ryzyka, konsekwencji i działania, aby osiągnąć docelową długość.

Inne typy postów mogą używać warning boxa, gdy pojawią się te same wyzwalacze. Tabela definiuje powtarzające się, nieopcjonalne przypadki; nie przyznaje zwolnienia formatom pominiętym w postTypes.

Lista kontrolna QA

Przed publikacją zweryfikuj wszystkie następujące punkty:

• Warning box nazywa jedno konkretne działanie, warunek lub decyzję, które stwarzają ryzyko.
• Konsekwencja określa, co może się stać i kogo lub czego dotyczy, bez przesady.
• Działanie mówi czytelnikowi, jak uniknąć, zmniejszyć, zweryfikować, zatrzymać lub eskalować ryzyko.
• Ostrzeżenie pojawia się przed pierwszym regulowanym działaniem i jasno określa swój zakres.
• Żadna wskazówka, promocja, baner ani drugi warning box nie konkurują z nim bezpośrednio.
• Obowiązkowy wyzwalacz nie został pominięty ani skrócony ze względu na układ lub liczbę słów.
• Typ important i konkretny tekstowy tytuł ostrzeżenia są obecne.
• Powaga pozostaje jasna bez koloru, ikon, obrazów lub otaczającego kontekstu.
• Statyczne ostrzeżenie nie używa niepotrzebnej roli alert; dynamiczne pilne ostrzeżenie jest ogłaszane odpowiednio.
• Wszelkie zastrzeżenia pozostają oddzielne i nie zastępują wskazówek w punkcie działania.
• Regulowane sformułowania i wymagana terminologia mają odpowiednie zatwierdzenie merytoryczne.
• Mapowania Markdown, Hugo i WordPress zachowują ten sam tytuł, body i pozycję.
• Body mieści się w zakresie 25–90 słów, nie zawiera języka marketingowego i używa nie więcej niż jednego niezbędnego linku.
• Komentarze dotyczące zrzutów ekranu wymieniają tylko wymagane przyszłe przechwycenia; żadna nieistniejąca ścieżka obrazu nie jest renderowana.

FAQ

Co musi zawierać każdy warning box? Konkretne ryzyko, jego wiarygodna konsekwencja i bezpieczne działanie muszą być obecne. Element jest niekompletny bez któregokolwiek z nich.

Czy warning box może pojawić się po ryzykownym działaniu? Nie. Musi pojawić się, zanim czytelnik będzie mógł działać, nawet jeśli wymaga to restrukturyzacji otaczających kroków.

Czy zastrzeżenie prawne zastępuje warning box? Nie. Zastrzeżenie określa zakres lub ograniczenia; ostrzeżenie zmienia zachowanie w konkretnym punkcie decyzyjnym. Strony regulowane mogą wymagać obu.

Czy warning box powinien używać roli alert? Nie, gdy jest już obecny przy ładowaniu strony. Zarezerwuj rolę alert dla pilnych informacji wprowadzanych dynamicznie po interakcji.

Ile warning boxów może zawierać strona? Użyj jednego na odrębny punkt decyzyjny i łącz ostrzeżenia z tym samym celem. Jeśli warning boxy dominują na stronie, przebuduj procedurę lub rozważ, czy dane działanie powinno być w ogóle oferowane.

Warning box zasługuje na swoją widoczność tylko wtedy, gdy zapobiega konkretnej szkodzie. Określ ryzyko, konsekwencję i działanie spokojnie, umieść je przed decyzją i zachowaj to znaczenie w każdym wyjściu.