Advarselsboks: Når og hvordan du bruker den
Bruk advarselsbokser til å angi en spesifikk risiko, forklare konsekvensen og gi den sikre handlingen før irreversibelt, kostbart, regulert eller farlig arbeid.
En advarselsboks stopper en leser før en handling som kan forårsake materiell skade. Det er ikke en generell uthevingsstil. En publiserbar advarsel angir risikoen, konsekvensen og handlingen som unngår eller begrenser skaden.
Det levende elementet fungerer fordi det identifiserer hva som kan gå galt, forklarer hva som vil gå tapt, og gir en trygg sekvens før den destruktive kontrollen. «Vær forsiktig når du sletter» ville ikke vært nok: det overfører risikovurderingen tilbake til leseren uten å fortelle dem hva forsiktig oppførsel innebærer.
Hvorfor dette elementet er viktig
Advarsler eksisterer for å endre en beslutning før skade oppstår. En leser som følger instruksjoner, konsentrerer seg vanligvis om å nå det lovede resultatet, så de kan skumlese forbehold som ser ut som vanlig bakgrunnsinformasjon. En tydelig avgrenset advarsel avbryter dette momentet på punktet hvor leseren fortsatt har et valg. Det skaper en bevisst pause, forklarer hvorfor pausen betyr noe, og gir en trygg neste handling.
Dette elementet tjener leserens psykologi kun så lenge forfattere bruker det selektivt. Hvis rutinemessige råd, mindre ulemper og irreversibelt tap alle får samme behandling, lærer leserne at det visuelle signalet sjelden betyr noe. De begynner å hoppe over det. Overdrivelse skaper derfor den nøyaktige feilmodusen en advarsel er ment å forhindre: den viktige meldingen blir nedvurdert når innsatsen er reell. Tonen skal informere, ikke skremme.
Maskinuttrekkbarhet betyr at programvare kan isolere advarselen og bevare meningen utenfor de omkringliggende avsnittene. En skrevet blokk med en tekstlig advarselsetikett og en selvstendig brødtekst er lettere å identifisere enn en rød setning gjemt inne i et trinn. Risiko–konsekvens–handling-strukturen overlever også presentasjonsendringer. Et automatisert publiseringssystem kan flytte innholdet mellom Markdown, Hugo og WordPress uten å måtte slutte hvilken setning som beskriver skade eller hva leseren bør gjøre.
Følg skrivereglene for elementer når du kartlegger elementet. Farge, et ikon, fet tekst eller en overskrift kalt «Viktig» skaper ikke i seg selv advarselssemantikk. Ordene må forbli fullstendige når de kopieres som ren tekst eller leses uten sidens visuelle stil.
Når du skal bruke det
Bruk en advarsel når leseren er i ferd med å ta et valg eller utføre en handling med en forutsigbar materiell konsekvens. Elementet er obligatorisk når innholdet dekker noen av disse utløserne:
- Irreversibel handling: sletting, overskriving, publisering, innsending, kontolukking eller en annen handling som ikke pålitelig kan angres.
- Datatap eller -eksponering: poster kan bli slettet, korrumpert, avslørt, overført eller gjort utilgjengelige.
- Kostnadskonsekvens: en handling starter en avgift, fornyer en forpliktelse, bruker en betalt kvote eller skaper en kostnad som ikke er åpenbar på beslutningspunktet.
- Sikkerhets- eller helserisiko: å følge, kombinere eller hoppe over en instruksjon kan forårsake skade, sykdom eller forsinket behandling.
- Juridisk eller etterlevelseseksponering: en handling kan bryte en lov, kontrakt, policy, lisens, oppbevaringsregel, samtykkekrav eller regulert godkjenningsprosess.
Utløseren, ikke forfatterens preferanse eller tilgjengelig ordantall, styrer inkludering. Hvis en av dem gjelder, kan advarselen ikke forkortes til en vag etikett, flyttes til en generell ansvarsfraskrivelse eller utelates for å passe en mal. Forkort heller omkringliggende forklaring først.
Ikke bruk en advarsel for en nyttig snarvei, en beste praksis, en definisjon, en mild ulempe, en normal forutsetning eller en reversibel feil med en åpenbar gjenoppretting. Dette er nesten-treff fordi de kan være «viktige» i dagligtale, men krever ikke en stoppbeslutning. Sett nødvendige forutsetninger i prosedyren, valgfrie forbedringer i en tipsboks og vanlig feilgjenoppretting ved siden av trinnet det reparerer.
Ikke advar bare fordi et utfall er uønsket. «Titler av lav kvalitet kan redusere klikk» er en forklaring på ytelse, ikke en advarsel. Det blir advarselsmateriale kun når en nærliggende handling skaper en spesifikk, materiell konsekvens: for eksempel kan endring av URL-strukturen på en live-side uten omdirigeringer bryte innkommende lenker og fjerne indekserte destinasjoner. I så fall, angi den forebyggende handlingen før endringen.
Hvor du skal plassere den
En advarsel hører umiddelbart før den tidligste handlingen den gjelder. «Handling» inkluderer en nummerert instruksjon, kommando, skjemainnsending, kjøpskontroll, nedlasting, anbefaling eller beslutning som en leser kan handle på. Sett boksen etter nok kontekst til å identifisere situasjonen, men før den første utførbare instruksjonen. Avslør aldri risikoen etter handlingen, i sluttnoter eller kun i en avsluttende FAQ.
Hvis én advarsel styrer en sekvens, plasser den før sekvensen og angi omfanget: «De neste tre trinnene erstatter produksjonsdatabasen.» Ikke gjenta den samme advarselen i hvert trinn. Hvis et senere trinn introduserer en annen risiko, legg til en ny advarsel umiddelbart før det trinnet.
En advarsel kan ikke sitte direkte ved siden av et annet utrop, en salgsfremmende handlingsknapp eller et dekorativt banner. Tilstøtende bokser konkurrerer om oppmerksomhet og kan få advarselen til å se ut som en del av en markedsføringsstabel. Den må ikke splitte en instruksjon fra dens nødvendige input, en påstand fra dens bevis, eller en tabelltittel fra tabellen. Legg til en enkel overgang eller omstrukturer seksjonen slik at advarselen tydelig kvalifiserer én beslutning.
Plasser juridiske standardformuleringer i henhold til gjeldende policy, men behold den operative advarselen ved siden av den risikofylte handlingen. Å flytte advarselen til en bunntekst fordi en ansvarsfraskrivelse allerede finnes, motvirker formålet.
Anatomi
Det gjengitte elementet har seks semantiske regioner:
- Alvorlighetsgradetikett: synlig tekst som sier at dette er en advarsel; det kan ikke formidles av farge eller et ikon alene.
- Spesifikk tittel: navngir beslutningen eller faren, for eksempel «Advarsel: eksporter poster før sletting».
- Risiko: angir hvilken handling eller tilstand som kan gå galt.
- Konsekvens: angir det troverdige resultatet og hvem eller hva som påvirkes.
- Handling: forteller leseren hvordan de kan unngå, redusere, verifisere eller eskalere risikoen før de fortsetter.
- Posisjonsforhold: kobler advarselen til neste handling den styrer.
Forklaringen forblir som levende sidetekst i stedet for å være bakt inn i bildet. Det holder hver etikett tilgjengelig for hjelpemiddelteknologi og lar designet endres uten å gjøre spesifikasjonen unøyaktig.
Designeksempler
Det nåværende biblioteket støtter én advarselsalvorlighetsgrad: Hugo gjengir den med type="important". Det er ingen separat forsiktighets-, advarsels-, fare-, kritisk- eller nød-variant. Denne bevisste enkelheten gjør forfattervalg konsistente og reduserer sjansen for at to skribenter tildeler forskjellige farger til samme konsekvens. Avveiningen er at komponenten ikke visuelt kan skille mellom gjenopprettelig økonomisk tap og umiddelbar fysisk fare. Forfattere må angi alvorlighetsgrad i tittelen og konsekvensen i stedet for å stole på en sterkere farge.
Galleriet tester derfor den ene alvorlighetsgraden under dens støttede innholdsvariasjoner: standardetiketten, en spesifikk egendefinert tittel, maksimum to avsnitt og et smalt visningsområde. Dette er gjengivelsestilfeller, ikke forskjellige alvorlighetsnivåer.
Ikke oppfinn alvorlighetsgrad ved å legge til emojier, store bokstaver, gjentatte utropstegn, egendefinerte klasser eller ustøttede typeverdier. Hvis biblioteket senere får flere nivåer, må grensene deres være basert på konsekvens og nødvendig respons, ikke på hvor sterkt en forfatter føler for avsnittet.
Parametere
Gjengiveren har bare type, title og brødtekst-input. Risiko, konsekvens og handling er redaksjonelle felt innenfor brødteksten; å holde dem eksplisitte i denne kontrakten forhindrer at en visuelt gyldig utrop publiserer ufullstendig veiledning.
| Navn | Type | Påkrevet | Min/maks | Standard | Kilde |
|---|---|---|---|---|---|
type | Enum | Ja | Nøyaktig important | Ingen for dette elementet | Shortcode-attributt |
title | Ren tekst | Ja | 3–9 ord; 70 tegn | Gjengiverens standard er Important, men advarselskontrakten krever en spesifikk tittel | Shortcode-attributt |
risk | Ren Markdown | Ja | 1 setning; 8–30 ord | Ingen | Brødtekst, første setning eller leddsetning |
consequence | Ren Markdown | Ja | 1 setning; 8–35 ord | Ingen | Brødtekst etter risikoen |
action | Ren Markdown | Ja | 1–2 setninger; 8–40 ord | Ingen | Brødtekst etter konsekvensen |
body | Markdown | Ja | 25–90 ord; 1–2 avsnitt | Ingen | Shortcode-brødtekst |
inlineLink | URL pluss anker | Nei | 0–1 lenke | Utelatt | Brødtekst |
position | Dokumentrelasjon | Ja | Én handling eller én navngitt sekvens | Umiddelbart før den styrte handlingen | Elementplassering |
Tittelen bør begynne med «Advarsel:» med mindre et regulert vokabular krever et annet eksplisitt alvorlighetsgradsord. Brødteksten kan kombinere risiko og konsekvens i én setning, men alle tre oppgavene må forbli identifiserbare. En lenke kan peke til detaljert policy eller gjenopprettingsinstruksjoner; den kan ikke erstatte den umiddelbare trygge handlingen.
Syntaks og kodeeksempler
Alle tre kartleggingene bærer samme type, tittel og brødtekst. Det portable direktivet er den kanoniske forfatterskapte formen. Hugo bruker den eksisterende callout-shortcoden. WordPress kan implementere samme kontrakt som en registrert blokk; en shortcode-form er akseptabel kun der installasjonen har registrert den.
Portabel Markdown-direktiv
:::warning{title="Advarsel: eksporter poster før sletting"}
Sletting av arbeidsområdet fjerner permanent de lagrede rapportene. Eksporter postene du må beholde og bekreft arbeidsområdenavnet før du bekrefter sletting.
:::
Hugo shortcode
{{< callout type="important" title="Advarsel: eksporter poster før sletting" >}}Sletting av arbeidsområdet fjerner permanent de lagrede rapportene. Eksporter postene du må beholde og bekreft arbeidsområdenavnet før du bekrefter sletting.{{< /callout >}}
Bruk navngitte parametere sammen. Ikke bland den posisjonelle important-verdien med en navngitt title-parameter.
WordPress-blokk eller shortcode
<!-- wp:amicited/warning {"title":"Advarsel: eksporter poster før sletting"} -->
<p>Sletting av arbeidsområdet fjerner permanent de lagrede rapportene. Eksporter postene du må beholde og bekreft arbeidsområdenavnet før du bekrefter sletting.</p>
<!-- /wp:amicited/warning -->
[warning title="Advarsel: eksporter poster før sletting"]Sletting av arbeidsområdet fjerner permanent de lagrede rapportene. Eksporter postene du må beholde og bekreft arbeidsområdenavnet før du bekrefter sletting.[/warning]
Presentasjonen kan variere mellom systemer, men den tekstlige alvorlighetsgraden, risikoen, konsekvensen, handlingen og plasseringen før handling må overleve konverteringen.
Eksempler
Bra: betalt reprossessering med overskrivingsrisiko
Dette eksemplet navngir to konkrete risikoer, angir begge konsekvensene og gir handlinger som forhindrer dem. Tonen er saklig: den hevder ikke at kontoen vil bli ødelagt eller at dataene vil være ugjenopprettelige hvis en bevart eksport gir en gjenopprettingsvei.
Dårlig: risiko uten veiledning
Det dårlige eksemplet identifiserer ikke operasjonen, beskriver ikke den troverdige konsekvensen, eller forteller leseren hvordan de skal fortsette trygt. «Alvorlige» er en uberettiget alvorlighetspåstand, mens «på egen risiko» flytter ansvar i stedet for å veilede atferd. Erstatt det med den nøyaktige tilstandsendringen, hva som kan gå tapt eller bli brutt, og kontrollen, sikkerhetskopien, godkjenningen, alternativet eller stoppbetingelsen som kreves før handling.
En annen svikt er overdreven alarmisme: «Ikke rør denne innstillingen, ellers kan hele nettstedet ditt bli ødelagt!» Selv om innstillingen betyr noe, er ordlyden ikke avgrenset av et sannsynlig utfall og gir ingen trygg vei. Lesere som oppdager at påstanden er overdrevet, vil nedvurdere senere advarsler.
Juridisk og regulert innhold
En ansvarsfraskrivelse og en advarsel utfører forskjellige oppgaver. En ansvarsfraskrivelse definerer omfang, kvalifikasjoner, usikkerhet, profesjonell status eller grensene for ansvar. En advarsel identifiserer en forutsigbar fare på et beslutningspunkt og endrer hva leseren bør gjøre videre. Den ene kan ikke erstatte den andre.
For juridisk, økonomisk, helse-, sikkerhets-, personvern- eller annet regulert materiale, behold den godkjente ansvarsfraskrivelsen på dens påkrevde sideplassering og legg til en advarsel før enhver spesifikk handling som kan skape eksponering. For eksempel fjerner ikke en generell uttalelse om at en artikkel er pedagogisk, behovet for å advare før du instruerer en leser om å stoppe foreskrevet behandling, overføre regulerte data, publisere en påstand uten godkjenning eller akseptere en gjentakende avgift.
Forfattere må ikke improvisere juridiske konklusjoner inne i advarselen. Bruk ordlyd godkjent av ansvarlig fagperson eller etterlevelsesgjennomgåer, bevar eventuell påkrevd terminologi, og gi den operative handlingen leseren faktisk kan ta: pause, innhent samtykke, behold poster, konsulter en kvalifisert fagperson, bruk en godkjent kanal, eller eskalere for gjennomgang. En vag lenke «se vilkårene» er utilstrekkelig når siden kan angi den umiddelbare stoppbetingelsen.
Schema-markering og tilgjengelighet
En advarselsboks har ingen dedikert Schema-markering
-egenskap og bør ikke lage et frittstående JSON-LD
-objekt. Den forblir synlig innhold innenfor den omsluttende artikkelen. Når den kvalifiserer en strukturert prosedyre, kan hele teksten inkluderes i det relevante trinnets synlige instruksjon og tilsvarende HowToStep.text; den må ikke bli et falskt trinn eller kun eksistere i strukturerte data.
ARIA-roller (Accessible Rich Internet Applications) kommuniserer grensesnittatferd til hjelpemiddelteknologi når native HTML ikke gir det. Statiske advarsler som er til stede når siden lastes, bør forbli i normal dokumentrekkefølge og trenger ikke role="alert". En alert-rolle forårsaker umiddelbar kunngjøring og er kun passende når en presserende advarsel vises dynamisk etter en interaksjon. Å bruke den på hvert statisk utrop kan avbryte skjermleserbrukere og gjøre rutinemessig sideinntreden støyende. Den nåværende Hugo-gjengiveren gir ut en merket <div> uten en ARIA-rolle, noe som er akseptabelt for en statisk blokk når teksten og plasseringen bærer meningen.
Fargeuavhengighet betyr at advarselen forblir gjenkjennelig i monokrom, høy kontrast-modus, en tekst-eksport og skjermleserutdata. Bruk en eksplisitt «Advarsel:»-tittel og beskriv alvorlighetsgrad i ord: «sletter permanent», «starter en gjentakende avgift», «kan eksponere personopplysninger» eller «krever medisinsk behandling». Ikke skriv «unngå det røde alternativet» eller stol på et ikons alternative tekst for å formidle faren.
Hold tittelen og brødteksten i leserekkefølge før den styrte handlingen. Lenker trenger beskrivende ankertekst, tastatortilgang må ikke avhenge av utropet, og essensielle instruksjoner kan ikke kun vises i et skjermbilde. Hvis en fremtidig interaktiv komponent tillater avvisning, må ikke avvisning skjule en obligatorisk advarsel før handlingen forblir tilgjengelig.
Skriveregler
Skriv én spesifikk advarsel på 25–90 ord og maksimalt to korte avsnitt. Bruk en tittel på 3–9 ord, normalt begynnende med «Advarsel:». Navngi den utløsende handlingen eller tilstanden, den troverdige konsekvensen og den trygge responsen. Sett grunnen før regelen: lesere etterlever mer pålitelig når de forstår hva regelen forhindrer.
Bruk proporsjonale verb. «Sletter permanent», «overskriver», «belaster», «eksponerer», «ugyldiggjør» og «kan forårsake» beskriver mekanismer eller utfall. «Ødelegger», «katastrofal», «skremmende» og «katastrofisk» dramatiserer vanligvis i stedet for å spesifisere. Angi usikkerhet ærlig når utfallet avhenger av kontekst, og garanter aldri sikkerhet bare fordi en leser følger én forholdsregel.
Hold ett beslutningspunkt per boks. En kort liste er kun akseptabel når flere kontroller alle må skje før den ene handlingen; ellers bruk prosa. Ikke legg salgsfremmende tekst, fordeler, attester, vitser, dekorative emojier, urelaterte tips, en full prosedyre, en sammenligningstabell, flere overskrifter eller en handlingsknapp inne i advarselen. Ikke skjul nødvendige instruksjoner bak en lenke.
Bruk aldri boksen til å skjerme en uberettiget påstand, skremme en leser til å kjøpe, eller skape kunstig hastegrad. Hvis handlingen er påkrevd, behold handlingen i hovedprosedyren i tillegg til å angi det forebyggende trinnet i advarselen. Boksen endrer oppmerksomhet; den erstatter ikke dokumentets operative struktur.
Posttyper som bruker det
postTypes-frontmatteren registrerer de registrerte formatene der advarselsutløsere er forutsigbare. I hver rad betyr «obligatorisk» at forfatteren ikke har noe skjønn når den angitte utløseren vises; elementet kan ikke fjernes eller komprimeres under risiko, konsekvens og handling for å nå et lengdemål.
| Posttype | Obligatorisk utløser | Påkrevd plassering |
|---|---|---|
| ultimate guide | Guiden inkluderer sikkerhets-, helse-, juridiske, etterlevelses-, betalte, destruktive eller datahåndteringsinstruksjoner. | Før den første risikofylte instruksjonen i hver uavhengig handlingsseksjon. |
| hvordan-guide | Ethvert trinn er irreversibelt, kan miste eller eksponere data, starter en kostnad, skaper regulert eksponering, eller medfører en sikkerhets- eller helserisiko. | Etter relevante forutsetninger og umiddelbart før det berørte trinnet eller sekvensen. |
| hva-er-side | Forklaringen inkluderer råd en leser kan handle på i en regulert, medisinsk, sikkerhetssensitiv eller juridisk konsekvensrik kontekst. | Før den første handlingsrettede anbefalingen, ikke inne i definisjonen. |
| produktside | En kontroll, kjøp, kansellering, migrering, sletting, integrasjon eller databruk har en materiell kostnad eller irreversibel konsekvens som ikke er åpenbar fra etiketten. | Ved siden av og før den relevante handlingen eller beslutningen; aldri kun i bunntekstvilkår. |
| kategoriside | Utvalgsråd kan skape en kompatibilitets-, totalkostnads-, sikkerhets-, helse-, juridisk eller etterlevelseskonsekvens. | Før anbefalingen eller filtervalget som eksponerer leseren for risikoen. |
| bruksområde-side | Den promoterte arbeidsflyten håndterer regulerte data, automatiserer en konsekvensrik beslutning, påløper kostnad, eller kan produsere irreversible eller usikre utfall. | Før arbeidsflytstadiet eller produkt-handlingen som introduserer eksponeringen. |
Andre posttyper kan bruke en advarsel når de samme utløserne vises. Tabellen definerer gjentakende, ikke-valgfrie tilfeller; den gir ikke unntak for formater som er utelatt fra postTypes.
QA-sjekkliste
Før publisering, verifiser følgende:
- Boksen navngir én spesifikk handling, tilstand eller beslutning som skaper risikoen.
- Konsekvensen angir hva som kan skje og hvem eller hva som påvirkes uten overdrivelse.
- Handlingen forteller leseren hvordan de kan unngå, redusere, verifisere, stoppe eller eskalere risikoen.
- Advarselen vises før den første styrte handlingen og navngir tydelig omfanget.
- Ingen tips, markedsføring, banner eller annen advarsel konkurrerer direkte med den.
- En obligatorisk utløser har ikke blitt utelatt eller forkortet for layout eller ordantall.
- Typen
importantog spesifikk tekstlig advarselstittel er til stede. - Alvorlighetsgrad er tydelig uten farge, ikoner, bilder eller omkringliggende kontekst.
- En statisk advarsel bruker ikke en unødvendig alert-rolle; en dynamisk presserende advarsel kunngjøres hensiktsmessig.
- Eventuelle ansvarsfraskrivelser forblir separate og erstatter ikke veiledning på handlingspunktet.
- Regulert ordlyd og påkrevd terminologi har hensiktsmessig faglig godkjenning.
- Markdown-, Hugo- og WordPress-kartlegginger bevarer samme tittel, brødtekst og plassering.
- Brødteksten holder seg innenfor 25–90 ord, inneholder ikke markedsføringsspråk og bruker ikke mer enn én nødvendig lenke.
- Skjermbildekommentarer navngir kun de nødvendige fremtidige opptakene; ingen ikke-eksisterende bildesti blir gjengitt.
FAQ
Hva må hver advarselsboks inneholde? Den spesifikke risikoen, dens troverdige konsekvens og den trygge handlingen må alle være til stede. Elementet er ufullstendig uten noen av dem.
Kan en advarselsboks vises etter den risikofylte handlingen? Nei. Den må vises før leseren kan handle, selv når det krever omstrukturering av de omkringliggende trinnene.
Kan et juridisk ansvarsfraskrivelse erstatte en advarselsboks? Nei. Ansvarsfraskrivelsen definerer omfang eller begrensninger; advarselen endrer atferd på et spesifikt beslutningspunkt. Regulerte sider kan kreve begge deler.
Bør en advarselsboks bruke en alert-rolle? Ikke når den allerede er til stede ved sidelasting. Reserver alert-rollen for presserende informasjon som introduseres dynamisk etter en interaksjon.
Hvor mange advarselsbokser kan en side inneholde? Bruk én per distinkt beslutningspunkt og konsolider advarsler med samme mål. Hvis advarsler dominerer siden, omstrukturer prosedyren eller vurder på nytt om handlingen bør tilbys i det hele tatt.
En advarselsboks fortjener sin visuelle fremtredelse kun når den forhindrer en konkret skade. Angi risikoen, konsekvensen og handlingen rolig, plasser dem før beslutningen, og bevar den meningen i hver utdata.
Flere veiledninger i denne delen
Klar til å sette det ut i livet?
Gratis sjekk · 7 dagers prøveperiode · ingen kredittkort