Reguli de urmat și de evitat: Ghid pereche

Un bloc de reguli de urmat și de evitat asociază o acțiune recomandată cu o greșeală cu același domeniu de aplicare și explică de ce greșeala eșuează. Valoarea sa provine din contrast: versiunea greșită expune un mod tentant de eșec, iar versiunea corectă oferă cititorului o înlocuire imediată.

Acest exemplu redat este modelul de producție. Fiecare rând abordează un subiect la același nivel de detaliu. „Nu faceți” denumește o eroare realistă și consecința sa; „Faceți” oferă o corecție utilizabilă. Etichetele, nu culoarea sau pictogramele, poartă distincția.

De ce contează acest element

Regulile sunt mai ușor de înțeles atunci când cititorii pot vedea limita pe care trebuie să o respecte. O instrucțiune pozitivă singură poate părea abstractă: „Folosiți dovezi specifice” nu dezvăluie ce este considerat prea vag. O instrucțiune negativă singură creează fricțiune: „Nu faceți afirmații nefondate” spune ce să evitați, dar lasă pasul următor neclar. Plasarea celor două împreună transformă o limită într-o alegere asupra căreia cititorul poate acționa.

Versiunea greșită este instructivă deoarece seamănă adesea cu ceea ce ar scrie în mod natural o persoană ocupată. Arătarea acestei aproape greșeli îl ajută pe cititor să o recunoască în propria sa muncă. Motivul contează la fel de mult. „Nu folosiți un limbaj vag” cere ascultare; „Nu scrieți «rapid» fără a numi sarcina măsurată, deoarece cititorii nu pot verifica sau compara” învață un principiu care se transferă la exemple noi.

Paritatea înseamnă că ambele părți acoperă subiecte, număr, detalii și greutate editorială echivalente. Împiedică o coloană „Faceți” lustruită să stea lângă o grămadă de avertismente fără legătură. Cititorii pot scana o pereche, pot înțelege contrastul și pot continua fără să își amintească un element din altă parte a paginii.

Extractibilitatea automată este capacitatea software-ului de a izola conținutul păstrându-i în același timp sensul și relațiile. Titlurile vizibile, structura de listă și perechile aliniate pe rânduri permit sistemelor de căutare și motoarelor de răspuns să recupereze afirmații precum „Pentru prețuri, menționați planul și data; evitați cifrele fără dată deoarece domeniul lor de aplicare este neverificabil.” Dacă cele două părți conțin puncte fără legătură sau motivul este sugerat doar printr-o pictogramă, extragerea poate păstra comanda pierzând calificarea care o face sigură.

Urmați regulile de redactare a elementelor înainte de a selecta acest bloc. Scopul are prioritate față de aspect. Conținutul care avertizează în principal despre un pericol imediat rămâne un avertisment; o secvență rămâne o listă de pași; un set finit de verificări de finalizare rămâne o listă de verificare. Două coloane colorate nu transformă aceste scopuri în reguli de urmat și de evitat.

Când să îl folosiți

Folosiți acest element atunci când cititorii trebuie să distingă o practică recomandată de o greșeală plauzibilă cu consecințe. Contrastul ar trebui să reducă ambiguitatea mai eficient decât o singură instrucțiune. Subiectele potrivite includ standarde editoriale, convenții de implementare, controale de calitate, comportament de design, manipulare a datelor și alegeri de proces.

Toate aceste condiții ar trebui să fie adevărate:

1. Fiecare greșeală are o acțiune de înlocuire responsabilă.
2. Motivul pentru evitarea greșelii poate fi exprimat într-o singură frază scurtă.
3. Elementele sunt îndrumări independente, nu pași care trebuie finalizați în ordine.
4. Ambele părți pot folosi același domeniu de aplicare și același nivel de specificitate.

Cazurile apropiate sunt frecvente:

• Avantaje și dezavantaje: avantajele și limitările evaluează o opțiune. Regulile de urmat și de evitat instruiesc comportamentul cititorului. „Include proiecte nelimitate” este un avantaj, nu o regulă de urmat.
• Avertisment: o consecință gravă sau ireversibilă necesită o evidențiere directă și un răspuns, nu o coloană însoțitoare cu greutate egală.
• Listă de verificare: o listă de verificare urmărește dacă munca necesară este finalizată. Starea sa nebifată nu este un „Nu faceți”.
• Tabel comparativ: un tabel evaluează mai multe opțiuni în funcție de criterii comune. Nu prescrie un comportament corect și incorect.
• Înainte și după: două exemple pot arăta o editare fără a exprima o regulă comportamentală reutilizabilă. Folosiți reguli de urmat și de evitat numai atunci când contrastul învață o practică generală.
• Stil arbitrar al casei: dacă nu poate fi explicată nicio consecință pentru cititor, sistem, conformitate sau întreținere, documentați convenția ca regulă în loc să pretindeți că alternativa este o greșeală.

Nu folosiți blocul pentru a fabrica opoziția. „Scrieți clar; nu scrieți neclar” reia aceeași abstractizare și nu învață nimic. Partea greșită trebuie să fie suficient de tentantă pentru a fi recunoscută și suficient de specifică pentru a fi diagnosticată.

Unde să îl plasați

Plasați blocul după ce pagina a definit sarcina, publicul și orice termeni necesari pentru înțelegerea ghidului. Acesta aparține imediat după explicația sau demonstrația pe care o condensează, sau aproape de sfârșitul unei secțiuni, ca o recapitulare practică înainte ca cititorul să acționeze.

Reguli exacte de plasare:

• Introduceți un subiect în titlul cel mai apropiat. Fiecare pereche trebuie să aibă sens în cadrul acelui subiect fără a împrumuta domeniul de aplicare dintr-un paragraf îndepărtat.
• Puneți blocul după principiul guvernator și înaintea unei liste de verificare a implementării sau a unei acțiuni următoare. Cititorii ar trebui să înțeleagă de ce înainte de a verifica finalizarea.
• În secțiuni repetate, folosiți aceeași poziție și aceleași limite de perechi. Mutarea imprevizibilă a blocului îngreunează scanarea între subiecte.
• Păstrați listele pereche împreună în ordinea sursei și în aspectul vizual. Textul explicativ poate urma după blocul complet, nu poate diviza părțile sale.

Nu poate sta direct lângă un alt element decizional cu două coloane, deoarece grilele adiacente obscură care etichete și rânduri aparțin împreună. Nu plasați o mărturie, un banner promoțional, un formular sau un îndemn la acțiune între părțile „Faceți” și „Nu faceți”. Nu faceți din acesta primul conținut semnificativ al unei pagini atunci când regulile depind de termeni sau context pe care cititorul nu i-a primit încă.

Anatomie

Legendă redată

1. Titlul subiectului: denumește sarcina sau decizia delimitată comună fiecărei perechi.
2. Eticheta Faceți: text vizibil care identifică comportamentul recomandat; o pictogramă sau un tratament verde este suplimentar.
3. Eticheta Nu faceți: text vizibil care identifică comportamentul de evitat; punctuația folosește forma editorială localizată.
4. Enunțul de acțiune: o instrucțiune imperativă sau declarativă care denumește un comportament observabil.
5. Motivul: o frază care leagă instrucțiunea de o consecință, un mod de eșec sau un principiu guvernator.
6. Relația perechii: ordinea sursei și aspectul păstrează care „Faceți” răspunde la care „Nu faceți”.
7. Nota opțională a sursei: identifică politica, testul, reglementarea sau dovada care guvernează cerințele faptice.

Autorul furnizează subiectul, perechile și motivele. Renderul furnizează prezentare egală, stivuire responsive, etichete accesibile și pictograme decorative acolo unde este cazul.

Exemple de design

Următoarele variante sunt setul complet suportat. Ele modifică densitatea și aranjamentul, niciodată paritatea sau contractul de raționament.

Rânduri pereche standard

Folosiți între trei și șapte rânduri aliniate orizontal pe ecrane late. Fiecare rând conține un „Faceți” și un „Nu faceți” despre același subiect.

Perechi stivuite pentru mobil

La lățimi înguste, păstrați fiecare pereche împreună: „Faceți”, apoi „Nu faceți”, apoi următoarea pereche. Stivuirea tuturor elementelor pozitive înaintea tuturor elementelor negative ar ascunde corespondența.

Variantă ghidată de exemple

Folosiți când limbajul exact, markupul sau comportamentul interfeței sunt mai utile decât o comandă abstractă. Fiecare parte arată un exemplu scurt urmat de motivul său. Codul rămâne text selectabil.

Variantă compactă de recapitulare

Folosiți numai atunci când motivele guvernatoare au fost deja explicate imediat mai sus. Motivul apare totuși în fiecare element, dar într-o frază scurtă, nu într-un paragraf separat.

Nu creați variante doar cu pictograme, carusel, file sau pliabile independent. Acestea separă perechea, ascund o parte sau fac comparația dependentă de interacțiune.

Parametri

Contractul modelează perechi, nu două liste fără legătură. „Sursa” descrie de unde obține renderul fiecare valoare.

Primul titlu din corp se mapează la heading. Fiecare pair imbricat deține ambele acțiuni și ambele motive. Modelul sursă nu trebuie să stocheze toate elementele pozitive separat de toate elementele negative, deoarece aceasta face corespondența rândurilor dependentă de poziția în matrice și ușor de rupt în timpul editării.

Sintaxă și exemple de cod

Toate cele trei formate păstrează același subiect, ordinea perechilor, acțiunile și motivele. Ele nu deduc un motiv din acțiune și nu creează automat un element pozitiv.

Directivă Markdown portabilă

:::dos-and-donts
## Redactarea afirmațiilor comparative

::item{do="Menționați exact planul și data verificată" dont="Nu publicați un preț fără dată"}
### Faceți
Faptele comerciale se schimbă, așadar domeniul de aplicare permite cititorilor să verifice și să reutilizeze afirmația.

### Nu faceți
Cititorii nu pot stabili ce plan sau perioadă descrie o cifră fără dată.
::

::item{do="Comparați ambele produse după același criteriu" dont="Nu comparați capacități fără legătură"}
### Faceți
O măsură comună face diferența semnificativă.

### Nu faceți
Criterii diferite creează aparența unei comparații fără o alegere validă.
::
:::

Acest element suprascrie maparea implicită a elementelor: titlul părinte furnizează heading; atributele elementelor furnizează acțiunile; primele subtitluri Faceți și Nu faceți mapează textul următor la cele două motive.

Shortcode Hugo

Niciun shortcode Hugo de producție nu implementează în prezent contractul de înregistrare pereche. Până când va exista unul, redați HTML semantic ca în exemplul live, în loc să folosiți doi ajutori de listă fără legătură. Adaptorul intenționat este:

{{< dos-and-donts >}}
## Redactarea afirmațiilor comparative

{{< do-dont-pair do="Menționați exact planul și data verificată" dont="Nu publicați un preț fără dată" >}}
### Faceți
Faptele comerciale se schimbă, așadar domeniul de aplicare permite cititorilor să verifice și să reutilizeze afirmația.
### Nu faceți
Cititorii nu pot stabili ce plan sau perioadă descrie o cifră fără dată.
{{< /do-dont-pair >}}
{{< /dos-and-donts >}}

Renderul viitor trebuie să producă o regiune etichetată cu o listă de înregistrări pereche. Nu trebuie să creeze două matrice și să le îmbine după index după redare.

Bloc sau shortcode WordPress

[dos_and_donts heading="Redactarea afirmațiilor comparative" variant="standard"]
[pair]
[do action="Menționați exact planul și data verificată"]Faptele comerciale se schimbă, așadar domeniul de aplicare permite cititorilor să verifice și să reutilizeze afirmația.[/do]
[dont action="Nu publicați un preț fără dată"]Cititorii nu pot stabili ce plan sau perioadă descrie o cifră fără dată.[/dont]
[/pair]
[pair]
[do action="Comparați ambele produse după același criteriu"]O măsură comună face diferența semnificativă.[/do]
[dont action="Nu comparați capacități fără legătură"]Criterii diferite creează aparența unei comparații fără o alegere validă.[/dont]
[/pair]
[/dos_and_donts]

Un bloc WordPress personalizat ar trebui să editeze fiecare pereche ca o singură înregistrare și să prevină publicarea atunci când lipsește o acțiune sau un motiv.

Exemple

Corect: echivalent, acționabil și motivat

Perechile împărtășesc un subiect în fiecare rând: domeniul planului, fereastra de timp și starea dovezilor. Ambele acțiuni sunt suficient de specifice pentru a fi revizuite într-un draft, iar fiecare motiv explică ce poate merge prost. Cititorul poate aplica principiul chiar și atunci când prețul, produsul sau perioada exactă se schimbă.

Greșit: două grămezi de comenzi

Acest eșec apare deoarece coloanele sunt fără legătură și inegale. „Fiți exact” nu are o condiție de finalizare observabilă, în timp ce „Nu folosiți niciodată jargon” interzice limbajul fără a distinge termenii necesari de termenii neexplicați. Niciunul dintre elementele negative nu enunță o consecință, iar celula goală dezvăluie că autorul a creat două liste, nu patru perechi.

Reparați blocul alegând un subiect, apoi scriind rânduri echivalente. Pentru terminologie, perechea ar putea fi: „Definiți un termen de specialitate necesar la prima utilizare, deoarece definiția permite nou-veniților să urmărească argumentul” și „Nu înlocuiți un termen precis cu o expresie vagă de zi cu zi, deoarece substituirea poate schimba sensul.” Corecția învață raționamentul în loc să impună un slogan.

Markup Schema și accesibilitate

Schema.org nu oferă un tip general DoAndDont. Păstrați blocul vizibil în interiorul Article, TechArticle, HowTo sau al altor date structurate la nivel de pagină atunci când acea pagină se califică cu adevărat. Nu convertiți elementele pozitive în înregistrări HowToStep decât dacă acestea formează o procedură ordonată și nu publicați perechile ca FAQPage doar pentru că conțin explicații scurte.

Folosiți titluri și liste native. O secțiune exterioară primește numele său accesibil de la titlul subiectului. Fiecare pereche ar trebui să fie un element de listă sau o înregistrare grupată care conține o etichetă vizibilă „Faceți” și o etichetă vizibilă „Nu faceți”. Păstrați fiecare pereche în ordinea sursei, astfel încât un utilizator de cititor de ecran să întâlnească recomandarea și greșeala corespunzătoare împreună.

Culoarea și pictogramele sunt suplimentare. Verdele nu poate fi singurul semnal pentru „Faceți”, iar o cruce nu poate fi singurul semnal pentru „Nu faceți”. Pictogramele decorative primesc text alternativ gol sau sunt ascunse de tehnologia de asistență. Nu faceți un bloc static focusabil. Dacă revărsarea orizontală este inevitabilă pentru un tabel de exemplu, delimitați și etichetați regiunea de derulare; componenta de producție ar trebui să stivuiască perechile în schimb.

Contracția „Nu faceți” este acceptabilă ca text editorial vizibil. Câmpurile de cod folosesc dont sigur pentru ASCII acolo unde apostrofurile ar complica numele atributelor. Renderele localizează etichetele fără a modifica acțiunile sau motivele stocate.

Reguli de redactare

Scrieți motivul înainte de a finaliza comanda. Acest lucru îl forțează pe autor să identifice consecința pentru cititor, sistem, siguranță, conformitate sau întreținere. Dacă nu se poate scrie un motiv apărabil, interdicția poate fi o preferință, nu o îndrumare.

Folosiți între trei și șapte perechi. Fiecare acțiune ar trebui să exprime un comportament observabil în 110 caractere sau mai puțin acolo unde este practic. Oferiți fiecărei părți o frază motivatoare de cel mult 180 de caractere. Limitele mențin cele două părți scanabile; calificările mai lungi aparțin textului înconjurător.

Mențineți paritatea în cinci dimensiuni:

• Subiect: ambele acțiuni abordeaz aceeași decizie sau același artifact.
• Altitudine: o regulă precisă de markup nu poate fi asociată cu o maximă largă precum „scrieți bine”.
• Gramatică: folosiți imperative paralele sau enunțuri declarative paralele.
• Dovezi: aplicați același prag faptic și de documentare ambelor părți.
• Greutate vizuală: nicio parte nu primește mai mult spațiu, accent, detaliu sau vizibilitate implicită.

Folosiți un limbaj direct și neutru. Preferați „Nu publicați un preț neverificat” în locul unui limbaj de rușinare precum „Doar scriitorii neglijenți uită să verifice prețurile.” Evitați sarcasmul, frica și termenii absoluți, cu excepția cazului în care regula este cu adevărat absolută și domeniul său de aplicare este precizat.

Nu puneți niciodată următoarele în interiorul elementului:

• Sfaturi fără legătură adăugate pentru a umple o parte sau a forța simetria numerică.
• O interdicție fără o consecință, un principiu sau o acțiune de înlocuire.
• Proceduri ordonate, căsuțe de bifat, evaluări, verdicte sau avantaje și limitări ale produselor.
• Avertismente critice de siguranță, clauze de exonerare juridice, instrucțiuni de urgență sau notificări de acțiuni ireversibile.
• Mărturii, citate lungi, elemente media, formulare, îndemnuri la acțiune, butoane promoționale sau coduri de cupon.
• Acordeoane imbricate, file, caruseluri, tabele comparative sau un alt bloc de reguli de urmat și de evitat.
• Afirmații despre persoane sau grupuri formulate ca eșec moral, nu ca comportament observabil.

Atunci când o cerință provine dintr-o politică, reglementare, test sau standard extern, adăugați o notă a sursei în apropiere. Atribuiți regula suficient de precis pentru ca un editor să o poată reverifica; nu faceți blocul să poarte un aparat lung de citare.

Tipuri de postări care îl folosesc

Matricea postTypes din frontmatter conduce această matrice de utilizare. Includerea face elementul disponibil în condiția menționată; nu face blocul obligatoriu pe fiecare pagină de acel tip.

Listă de verificare QA

• Blocul are un subiect delimitat, clar din titlul său cel mai apropiat.
• Principiul guvernator apare înaintea blocului, astfel încât perechile să întărească regula, nu să o inventeze.
• Există între trei și șapte perechi complete și exact același număr de acțiuni „Faceți” și „Nu faceți”.
• Fiecare pereche abordează același subiect, același public, același domeniu de aplicare și același nivel de specificitate.
• Fiecare „Nu faceți” numește o greșeală realistă și explică consecința sau modul de eșec.
• Fiecare „Faceți” oferă o înlocuire acționabilă și explică de ce funcționează.
• Niciun element nu doar neagă partenerul, nu repetă un slogan sau nu folosește formulări circulare.
• Acțiunile conțin un singur comportament și se mențin în apropierea țintei de 110 caractere.
• Motivele conțin o singură frază și se încadrează în 180 de caractere.
• Ambele părți folosesc gramatică paralelă, standarde de dovezi, detalii și greutate vizuală paralele.
• Cerințele faptice identifică politica, reglementarea, testul sau sursa acolo unde este necesar.
• Blocul nu conține pași, stări de bifare, compromisuri de produs, avertismente severe, promoții, formulare sau elemente complexe imbricate.
• Textul vizibil spune „Faceți” și „Nu faceți”; culoarea, poziția și pictogramele nu sunt singurele semnale.
• Ieșirea responsive păstrează fiecare pereche împreună, în loc să stivuiască toate elementele pozitive înaintea tuturor elementelor negative.
• Titlul subiectului și structura perechilor rămân comprehensibile în text simplu și când stilurile sau scripturile nu sunt disponibile.
• Datele structurate descriu doar pagina gazdă și nu inventează un tip de schemă pentru reguli de urmat și de evitat.
• Comentariile de captură de ecran rămân instrucțiuni de captare care nu se redau, până când există active reale.

FAQ

Șablonul academy redă cele cinci întrebări stocate în frontmatterul [[faq]] al acestei pagini. Acestea acoperă completitudinea perechilor, paritatea numerică, motivele, datele structurate și numărul de elemente.