Gør og lad være: Parrede vejledningsregler

En gør-og-lad-være-blok parrer en anbefalet handling med en tilsvarende fejl og forklarer, hvorfor fejlen slår fejl. Dens værdi kommer fra kontrast: den forkerte version afslører en fristende fejltilstand, mens den rigtige version giver læseren en umiddelbar erstatning.

Dette viste eksempel er produktionsmodellen. Hver række behandler ét emne på samme detaljeniveau. “Lad være” nævner en realistisk fejl og dens konsekvens; “Gør” giver en brugbar korrektion. Etiketter, ikke farve eller ikoner, bærer skelnen.

Hvorfor dette element er vigtigt

Regler er lettere at forstå, når læsere kan se den grænse, de skal respektere. En positiv instruktion alene kan virke abstrakt: “Brug specifik evidens” afslører ikke, hvad der tæller som for vagt. En negativ instruktion alene skaber friktion: “Kom med underbyggede påstande” siger, hvad man skal undgå, men efterlader næste skridt uklart. At sætte de to sammen gør en grænse til et valg, læseren kan handle på.

Den forkerte version er lærerig, fordi den ofte ligner, hvad en travl person naturligt ville skrive. At vise den næsten-fejl hjælper læseren med at genkende den i deres eget arbejde. Begrundelsen betyder lige så meget. “Brug ikke et uklart sprog” kræver lydighed; “Skriv ikke ‘hurtig’ uden at nævne den målte opgave, fordi læsere ikke kan verificere eller sammenligne det” lærer et princip, der overføres til nye eksempler.

Paritet betyder, at begge sider dækker tilsvarende emner, antal, detalje og redaktionel vægt. Det forhindrer en poleret “Gør”-kolonne i at sidde ved siden af en bunke urelaterede advarsler. Læsere kan scanne ét par, forstå kontrasten og fortsætte uden at skulle huske et punkt fra et andet sted på siden.

Maskinudtrækbarhed er evnen software har til at isolere indhold, mens dets betydning og relationer bevares. Synlige overskrifter, listestruktur og rækkejusterede par gør det muligt for søgesystemer og svarmaskiner at genfinde udsagn som “For priser: nævn plan og dato; undgå udaterede tal, fordi deres afgrænsning ikke kan verificeres.” Hvis de to sider indeholder urelaterede punkter, eller begrundelsen kun antydes af et ikon, kan udtrækning bevare kommandoen, mens den kvalifikation, der gør den sikker, går tabt.

Følg elementets skriveregler , før du vælger denne blok. Formål har forrang over udseende. Indhold, der primært advarer om umiddelbar skade, forbliver en advarsel; en sekvens forbliver en trinliste; et afgrænset sæt af afslutningskontrol forbliver en tjekliste. To farvede kolonner gør ikke disse formål til gør-og-lad-være-blokke.

Hvornår skal det bruges

Brug dette element, når læsere har brug for at skelne mellem en anbefalet praksis og en plausibel, konsekvensrig fejl. Kontrasten bør reducere tvetydighed mere effektivt end en enkelt instruktion. Egnede emner omfatter redaktionelle standarder, implementeringskonventioner, kvalitetskontroller, designadfærd, datahåndtering og procesvalg.

Alle disse betingelser bør være opfyldt:

1. Hver fejl har en ansvarlig erstatningshandling.
2. Årsagen til at undgå fejlen kan angives i én kort sætning.
3. Punkterne er uafhængig vejledning, ikke trin der skal udføres i rækkefølge.
4. Begge sider kan bruge samme omfang og detaljeringsgrad.

Næsten-fejl tilfælde er almindelige:

• Fordele og ulemper: fordele og begrænsninger vurderer én mulighed. Gør og lad være instruerer læserens adfærd. “Inkluderer ubegrænsede projekter” er en fordel, ikke et gør.
• Advarsel: en alvorlig eller irreversibel konsekvens kræver direkte fremhævelse og en reaktion, ikke en sidestillet ledsagerkolonne.
• Tjekliste: en tjekliste holder styr på, om nødvendigt arbejde er udført. Dens ikke-afkrydsede tilstand er ikke et “Lad være.”
• Sammenligningstabel: en tabel vurderer flere muligheder mod fælles kriterier. Den foreskriver ikke korrekt og forkert adfærd.
• Før og efter: to eksempler kan vise en redigering uden at udtrykke en genanvendelig adfærdsregel. Brug gør og lad være kun, når kontrasten lærer en generel praksis.
• Vilkårlig redaktionel stil: hvis der ikke kan forklares nogen konsekvens for læser, system, overholdelse eller vedligeholdelse, dokumentér konventionen som en regel i stedet for at foregive, at alternativet er en fejl.

Brug ikke blokken til at skabe modsætning. “Gør skriv klart; lad være med ikke at skrive uklart” gentager den samme abstraktion og lærer intet. Den forkerte side skal være fristende nok til at genkende og specifik nok til at diagnosticere.

Hvor skal den placeres

Placér blokken efter at siden har defineret opgaven, målgruppen og eventuelle begreber, der er nødvendige for at forstå vejledningen. Den hører til umiddelbart efter den forklaring eller demonstration, den sammenfatter, eller i nærheden af slutningen af et afsnit som en praktisk opsummering, før læseren handler.

Præcise placeringsregler:

• Introducér ét emne i den nærmeste overskrift. Hvert par skal give mening under det pågældende emne uden at låne afgrænsning fra et fjernt afsnit.
• Sæt blokken efter det styrende princip og før en implementeringstjekliste eller næste handling. Læsere bør forstå hvorfor, før de verificerer færdiggørelse.
• I gentagne sektioner skal du bruge samme position og par-begrænsninger. At flytte blokken uforudsigeligt gør det sværere at scanne på tværs af emner.
• Hold de parrede lister samlet i kildens rækkefølge og visuelle layout. Forklarende prosa må følge den komplette blok, ikke opdele dens sider.

Den må ikke sidde direkte ved siden af et andet to-kolonne beslutningselement, fordi tilstødende gitre gør det uklart, hvilke etiketter og rækker der hører sammen. Placér ikke et vidnesbyrd, reklamebanner, formular eller call-to-action mellem “Gør”- og “Lad være”-siderne. Gør det ikke til det første meningsfulde indhold på en side, når reglerne afhænger af begreber eller kontekst, læseren endnu ikke har modtaget.

Anatomi

Gengivet forklaring

1. Emneoverskrift: navngiver den afgrænsede opgave eller beslutning, der deles af hvert par.
2. Gør-etiket: synlig tekst, der identificerer anbefalet adfærd; et ikon eller grøn markering er supplerende.
3. Lad-være-etiket: synlig tekst, der identificerer adfærd, der skal undgås; tegnsætning bruger den lokaliserede redaktionelle form.
4. Handlingsudsagn: én imperativ eller deklarativ instruktion, der navngiver observerbar adfærd.
5. Begrundelse: én sætning, der forbinder instruktionen med en konsekvens, fejltilstand eller styrende princip.
6. Par-relation: kildens rækkefølge og layout bevarer, hvilket “Gør” der svarer til hvilket “Lad være.”
7. Valgfri kildehenvisning: identificerer den politik, test, regulering eller evidens, der styrer faktuelle krav.

Forfatteren leverer emnet, parrene og begrundelserne. Gengiveren leverer ensartet præsentation, responsiv stabling, tilgængelige etiketter og dekorative ikoner, hvor det er relevant.

Designeksempler

Følgende varianter er det komplette understøttede sæt. De ændrer tæthed og arrangement, aldrig pariteten eller begrundelseskontrakten.

Standard parrede rækker

Brug tre til syv vandret justerede rækker på brede skærme. Hver række indeholder ét “Gør” og ét “Lad være” om samme emne.

Stablede mobilpar

Ved smalle bredder holdes hvert par sammen: “Gør,” derefter “Lad være,” derefter næste par. At stable alle positive punkter før alle negative punkter ville skjule overensstemmelsen.

Eksempeldrevet variant

Brug, når præcist sprog, markup eller grænsefladeadfærd er mere nyttigt end en abstrakt kommando. Hver side viser ét kort eksempel efterfulgt af dets begrundelse. Kode forbliver valgbar tekst.

Kompakt gennemgangsvariant

Brug kun, når de styrende begrundelser allerede er forklaret umiddelbart ovenfor. Begrundelsen optræder stadig i hvert punkt, men i en kort frase snarere end et separat afsnit.

Opret ikke ikon-only, karrusel, faneblads- eller uafhængigt sammenklappelige varianter. De adskiller parret, skjuler den ene side eller gør sammenligning afhængig af interaktion.

Parametre

Kontrakten modellerer par snarere end to urelaterede lister. “Kilde” beskriver, hvor gengiveren henter hver værdi.

Den første brødtekstoverskrift mapper til heading. Hvert indlejret pair ejer både handlinger og begge begrundelser. Kildemodellen må ikke gemme alle positive punkter adskilt fra alle negative punkter, fordi det gør rækkeoverensstemmelse afhængig af array-position og let at bryde under redigering.

Syntaks og kodeeksempler

Alle tre formater bevarer samme emne, parrækkefølge, handlinger og begrundelser. De udleder ikke en begrundelse fra handlingen eller opretter automatisk et positivt punkt.

Bærbar Markdown-direktiv

:::dos-and-donts
## Writing comparison claims

::item{do="Name the exact plan and date checked" dont="Do not publish an undated price"}
### Do
Commercial facts change, so scope lets readers verify and reuse the claim.

### Don't
Readers cannot tell which plan or period an undated figure describes.
::

::item{do="Compare both products on the same criterion" dont="Do not compare unrelated capabilities"}
### Do
A shared measure makes the difference meaningful.

### Don't
Different criteria create the appearance of comparison without a valid choice.
::
:::

Dette element tilsidesætter standard elementtilknytningen: den overordnede overskrift leverer heading; elementattributter leverer handlingerne; de første Do- og Don't-underoverskrifter knytter deres efterfølgende tekst til de to begrundelser.

Hugo shortcode

Ingen produktions Hugo shortcode implementerer i øjeblikket parpost-kontrakten. Indtil en sådan findes, gengiv semantisk HTML som live-eksemplet i stedet for at bruge to urelaterede liste-hjælpere. Den påtænkte adapter er:

{{< dos-and-donts >}}
## Writing comparison claims

{{< do-dont-pair do="Name the exact plan and date checked" dont="Do not publish an undated price" >}}
### Do
Commercial facts change, so scope lets readers verify and reuse the claim.
### Don't
Readers cannot tell which plan or period an undated figure describes.
{{< /do-dont-pair >}}
{{< /dos-and-donts >}}

Den fremtidige gengiver skal producere ét mærket område med en liste af parrede poster. Den må ikke oprette to arrays og zippe dem efter indeks efter gengivelse.

WordPress-blok eller shortcode

[dos_and_donts heading="Writing comparison claims" variant="standard"]
[pair]
[do action="Name the exact plan and date checked"]Commercial facts change, so scope lets readers verify and reuse the claim.[/do]
[dont action="Do not publish an undated price"]Readers cannot tell which plan or period an undated figure describes.[/dont]
[/pair]
[pair]
[do action="Compare both products on the same criterion"]A shared measure makes the difference meaningful.[/do]
[dont action="Do not compare unrelated capabilities"]Different criteria create the appearance of comparison without a valid choice.[/dont]
[/pair]
[/dos_and_donts]

En brugerdefineret WordPress-blok bør redigere hvert par som én post og forhindre offentliggørelse, når en handling eller begrundelse mangler.

Eksempler

Godt: tilsvarende, handlingsorienteret og begrundet

Parrene deler et emne i hver række: planafgrænsning, tidsvindue og evidensstatus. Begge handlinger er specifikke nok til at gennemgå i et udkast, og hver begrundelse forklarer, hvad der kan gå galt. En læser kan anvende princippet, selv når den præcise pris, det præcise produkt eller den præcise periode ændrer sig.

Dårligt: to bunker af kommandoer

Dette fejler, fordi kolonnerne er urelaterede og ulige. “Vær præcis” har ingen observerbar afslutningsbetingelse, mens “Brug aldrig fagjargon” forbyder sprog uden at skelne mellem nødvendige termer og uforklarede termer. Ingen af de negative punkter angiver en konsekvens, og den tomme celle afslører, at forfatteren har oprettet to lister i stedet for fire par.

Reparér blokken ved at vælge ét emne og derefter skrive tilsvarende rækker. For terminologi kunne parret være: “Definér en nødvendig fagterm ved første brug, fordi definitionen gør det muligt for nytilkomne at følge argumentet” og “Erstat ikke en præcis term med et vagt hverdagssprog, fordi erstatningen kan ændre betydningen.” Korrektionen lærer dømmekraft i stedet for at håndhæve et slogan.

Schema-markup og tilgængelighed

Schema.org har ingen generel DoAndDont-type. Behold den synlige blok inden i den omsluttende Article, TechArticle, HowTo eller anden sidestruktureret data, når den pågældende side kvalificerer sig. Konvertér ikke de positive punkter til HowToStep-poster, medmindre de udgør en ordnet procedure, og offentliggør ikke parrene som FAQPage, blot fordi de indeholder korte forklaringer.

Brug native overskrifter og lister. Én ydre sektion modtager sit tilgængelige navn fra emneoverskriften. Hvert par skal være ét listepunkt eller en grupperet post, der indeholder en synlig “Gør”-etiket og en synlig “Lad være”-etiket. Bevar hvert par i kildens rækkefølge, så en skærmlæserbruger møder anbefalingen og dens matchende fejl sammen.

Farve og ikoner er supplerende. Grøn kan ikke være det eneste signal for “Gør,” og et kryds kan ikke være det eneste signal for “Lad være.” Dekorative ikoner får tom alternativ tekst eller er skjult for hjælpeteknologi. Gør ikke en statisk blok fokuserbar. Hvis horisontal overlapning er uundgåelig for en eksempeltabel, indehold og mærk scrollområdet; produktionskomponenten bør stable par i stedet.

Forkortelsen “Don’t” er acceptabel som synlig redaktionel tekst. Kodefelter bruger ASCII-sikkert dont, hvor apostrof ville komplicere attributnavne. Gengivere lokaliserer etiketterne uden at ændre de lagrede handlinger eller begrundelser.

Skriveregler

Skriv begrundelsen, før du færdiggør kommandoen. Dette tvinger forfatteren til at identificere konsekvensen for læser, system, sikkerhed, overholdelse eller vedligeholdelse. Hvis en forsvarlig begrundelse ikke kan skrives, er forbuddet muligvis en præference snarere end vejledning.

Brug tre til syv par. Hver handling skal udtrykke én observerbar adfærd på 110 tegn eller færre, hvor det er praktisk muligt. Giv hver side én begrundelsessætning på højst 180 tegn. Grænserne holder de to sides scanningsvenlige; længere kvalifikationer hører til i omliggende prosa.

Oprethold paritet på tværs af fem dimensioner:

• Emne: begge handlinger adresserer samme beslutning eller artefakt.
• Niveau: en præcis markup-regel kan ikke parres med en bred maksime som “skriv godt.”
• Grammatik: brug parallelle imperativer eller parallelle deklarative udsagn.
• Evidens: anvend samme faktuelle og kildekritiske tærskel på begge sider.
• Visuel vægt: ingen side får mere plads, fremhævelse, detalje eller standard synlighed.

Brug direkte, neutralt sprog. Foretræk “Offentliggør ikke en uverificeret pris” frem for skammende sprog som “Kun skødesløse skribenter glemmer at verificere priser.” Undgå sarkasme, frygt og absolutte termer, medmindre reglen er virkelig absolut og dens afgrænsning er angivet.

Læg aldrig disse inde i elementet:

• Urelaterede tips, der tilføjes for at fylde den ene side ud eller tvinge numerisk symmetri.
• Et forbud uden en konsekvens, et princip eller en erstatningshandling.
• Ordentlige procedurer, afkrydsningsfelter, bedømmelser, domme eller produktfordele og -begrænsninger.
• Sikkerhedskritiske advarsler, juridiske ansvarsfraskrivelser, nødinstruktioner eller meddelelser om irreversible handlinger.
• Vidnesbyrd, lange citater, medieindhold, formularer, call-to-action, reklameknapper eller rabatkoder.
• Indlejrede accordeons, faneblade, karruseller, sammenligningstabeller eller en anden gør-og-lad-være-blok.
• Påstande om personer eller grupper fremstillet som moralsk svigt snarere end observerbar adfærd.

Når et krav stammer fra en politik, regulering, test eller ekstern standard, tilføj en kildehenvisning i nærheden. Attribuér reglen præcist nok til, at en redaktør kan efterkontrollere den; lad ikke blokken bære et langt citationsapparat.

Posttyper, der bruger den

postTypes frontmatter-arrayet driver denne brugsmatrix. Inklusion gør elementet tilgængeligt under den angivne betingelse; det gør ikke blokken obligatorisk på hver side af den pågældende type.

QA-tjekliste

• Blokken har ét afgrænset emne, der er klart ud fra dens nærmeste overskrift.
• Det styrende princip optræder før blokken, så parrene forstærker snarere end opfinder reglen.
• Der er tre til syv komplette par og præcis samme antal “Gør”- og “Lad være”-handlinger.
• Hvert par adresserer samme emne, målgruppe, omfang og detaljeringsniveau.
• Hver “Lad være” navngiver en realistisk fejl og forklarer dens konsekvens eller fejltilstand.
• Hver “Gør” giver en handlingsorienteret erstatning og forklarer, hvorfor den virker.
• Intet punkt blot negerer sin partner, gentager et slogan eller bruger cirkulær formulering.
• Handlinger indeholder én adfærd og holder sig tæt på 110-tegns målet.
• Begrundelser indeholder én sætning og holder sig inden for 180 tegn.
• Begge sider bruger parallel grammatik, evidensstandarder, detaljeringsgrad og visuel vægt.
• Faktuelle krav identificerer deres politik, regulering, test eller kilde, hvor det er nødvendigt.
• Blokken indeholder ingen trin, checktilstande, produkt-afvejninger, alvorlige advarsler, reklame, formularer eller indlejrede komplekse elementer.
• Synlig tekst siger “Gør” og “Lad være”; farve, placering og ikoner er ikke de eneste signaler.
• Responsivt output holder hvert par sammen i stedet for at stable alle positive punkter før alle negative punkter.
• Emneoverskriften og parstrukturen forbliver forståelige i ren tekst og når stilarter eller scripts ikke er tilgængelige.
• Strukturerede data beskriver kun den omsluttende side og opfinder ikke en gør-og-lad-være-skematype.
• Screenshot-kommentarer forbliver ikke-gengivende optagelsesinstruktioner, indtil rigtige aktiver findes.

FAQ

Akademiskabelonen gengiver de fem spørgsmål, der er lagret i denne sides [[faq]] frontmatter. De dækker par-komplethed, numerisk paritet, begrundelser, strukturerede data og punkttælling.