Kontrolný zoznam: Pravidlá písania, umiestnenie a príklady

Kontrolný zoznam je konečná množina nezávislých akcií alebo overovacích brán, ktoré čitateľ môže označiť ako neúplné alebo dokončené. Jeho zaškrtnuteľný stav je súčasťou významu: splnenie každej požadovanej položky by malo preukázať, že pomenovaná úloha, kontrola alebo stav pripravenosti je hotový.

Tento vykreslený príklad má ohraničený rozsah, štyri stručné akcie, viditeľné nezaškrtnuté stavy a jednu podmienku dokončenia. Premena tých istých slov na dekoratívne odrážky by odstránila prísľub, že množina môže byť dokončená.

Prečo na tomto prvku záleží

Čitatelia používajú kontrolný zoznam na odľahčenie pamäte. Namiesto toho, aby museli držať v pamäti každú požiadavku pri prepínaní medzi konceptom, prehliadačom, dizajnom a publikačným rozhraním, môžu skontrolovať jednu podmienku naraz a zaznamenať pokrok. Konečná hranica znižuje neistotu: čitateľ vie, čo zostáva, čo znamená „hotovo“ a kedy je bezpečné pokračovať.

Táto psychologická zmluva je silnejšia než „tu je niekoľko užitočných nápadov.“ Zaškrtávacie políčko pozýva k záväzku, zatiaľ čo posledná nezaškrtnutá položka vytvára zámernú napätosť. Prvok preto musí byť čestný v rozsahu. Ak zoznam vynecháva požadovanú bránu alebo obsahuje vágne ambície ako „urobte stránku skvelou,“ rozhranie signalizuje istotu, ktorú si obsah nezaslúžil.

Strojová extrahovateľnosť je schopnosť vyhľadávačov, AI odpovedacích systémov, asistenčných technológií a publikačných nástrojov izolovať každú položku bez straty jej roly alebo modelu dokončenia. Typovaný kontrolný zoznam odhaľuje pomenovanú kolekciu, stabilné hranice položiek, počiatočné stavy a podmienku dokončenia. Analyzátor dokáže rozlíšiť požadované brány od príkladov alebo výhod, zatiaľ čo AI systém môže citovať jednu samostatnú akciu s neporušeným subjektom kontrolného zoznamu.

Pred výberom komponentu postupujte podľa pravidiel písania prvkov . Ich pravidlo priority je sémantické: ak je účelom bloku byť dokončený alebo overený, použite prvok kontrolného zoznamu, aj keď by rovnaké slová mohli zobraziť obyčajné odrážky. Vizuálna podobnosť nezachováva stav, validáciu, prístupnosť ani mapovanie adaptérov.

Kedy ho použiť

Použite kontrolný zoznam, keď je množina konečná, každá položka môže nezávisle prejsť alebo zlyhať a dokončenie požadovaných položiek vytvára zmysluplnú podmienku. Vhodné témy zahŕňajú kontrolu pred publikovaním, nákupné požiadavky, pripravenosť na migráciu, odovzdanie incidentu, kompletnosť dokumentu, kontrolu prístupnosti a pravidelnú údržbársku kontrolu.

Aplikujte tri testy:

1. Test stavu: Môže byť každá položka jednoznačne označená ako neúplná alebo dokončená?
2. Test hranice: Obsahuje zoznam všetky požadované kontroly pre svoj deklarovaný rozsah?
3. Test dokončenia: Preukazuje dokončenie požadovaných položiek pomenovaný výsledok?

Ak je odpoveď na niektorú otázku nie, iný prvok je pravdepodobne presnejší. Bežné takmer zásahy sú:

• Zoznam s odrážkami zoskupuje fakty, možnosti, príklady alebo atribúty. Jeho položky nie sú úlohy a množina sa nestáva dokončenou.
• Zoznam krokov kóduje závislé poradie. Ak presunutie položky 4 pred položku 2 môže spôsobiť zlyhanie, čísla a pokyny na obnovenie sú dôležitejšie ako zaškrtávacie políčka.
• Zoznam funkcií opisuje, čo produkt má. „Podporuje export CSV“ nie je kontrola, pokiaľ čitateľ neoveruje stanovenú požiadavku.
• Zoznam prianí zaznamenáva preferencie, ktorých hranice a priority sa môžu meniť. Nemal by sľubovať dokončenie.
• Hodnotiaca karta hodnotí dimenzie na škále. Binárne stavy zaškrtnutia by zahodili užitočné stupne výkonnosti.
• Dlhý postup so zaškrtávacím políčkom vedľa každého kliknutia zamieňa vykonávanie s overovaním. Vysvetlite postup ako kroky, potom pridajte krátky kontrolný zoznam na dokončenie.

Nepoužívajte kontrolný zoznam ako dekoráciu na konci každej sekcie. Opakované nezaškrtnuté políčka vnucujú prácu a naznačujú, že čitateľ nedokončil, aj keď obsah ponúkal iba voliteľné rady.

Kde ho umiestniť

Umiestnenie nasleduje okamih, v ktorom čitateľ môže konať alebo overovať. Najprv predstavte úlohu, rozsah a potrebný kontext; potom umiestnite kontrolný zoznam bezprostredne pred rozhodnutie, ktoré riadi, alebo bezprostredne za materiál, ktorý sumarizuje.

• Umiestnite kontrolný zoznam pripravenosti po predpokladoch a pred nezvratnou alebo nákladnou akciou.
• Umiestnite kontrolný zoznam zabezpečenia kvality po koncepte, konfigurácii alebo postupe, ktorý hodnotí, a pred schválením alebo publikovaním.
• Umiestnite kontrolný zoznam nákupných požiadaviek po vysvetlení potrieb a obmedzení, ale pred zostavením užšieho výberu produktov.
• Umiestnite kontrolný zoznam pravidelnej kontroly do sekcie údržby, vedľa jej frekvencie a zodpovednej osoby.
• Umiestnite hlavný kontrolný zoznam blízko vrchu vyhradeného článku s kontrolným zoznamom, po krátkom vyhlásení rozsahu, potom vysvetlite náročné položky nižšie.

Kontrolný zoznam nesmie byť umiestnený priamo vedľa druhého kontrolného zoznamu s prekrývajúcim sa rozsahom; zlúčte ich alebo každému dajte samostatný nadpis a podmienku dokončenia. Neumiestňujte ho vedľa sekvenčného zoznamu krokov bez uvedenia, ktorý blok je postup a ktorý je overenie. Nesmie oddeliť varovanie od následku alebo požadovanej reakcie, prerušiť porovnávaciu tabuľku ani byť umiestnený vo vnútri výzvy na akciu. Nikdy neumiestňujte propagačné tlačidlo medzi poslednú položku a podmienku dokončenia.

Anatómia

Označené oblasti sú:

1. Nadpis rozsahu: pomenúva presný objekt a rozhodnutie, napríklad „Kontrola odkazov pred publikovaním.“
2. Inštrukcia: hovorí, čo dokončenie umožňuje alebo preukazuje.
3. Ovládací prvok zaškrtnutia: programovo a vizuálne odhaľuje neúplný alebo dokončený stav.
4. Štítok akcie: začína konkrétnym slovesom a zostáva zrozumiteľný samostatne.
5. Voliteľný kvalifikátor: poskytuje prah, miesto, zodpovednú osobu alebo požiadavku na dôkaz.
6. Indikátor povinnosti: odlišuje voliteľné položky len vtedy, keď to zmluva skutočne umožňuje.
7. Zhrnutie pokroku: v interaktívnych variantoch uvádza dokončené a celkové požadované položky.
8. Podmienka dokončenia: uvádza výsledok dosiahnutý po splnení všetkých požadovaných položiek.

Slová zostávajú autoritatívne. Ikona zaškrtnutia, zelený riadok alebo prečiarknutý štítok môžu posilniť stav, ale žiadny z nich nemôže nahradiť natívny alebo programový zaškrtnutý stav.

Príklady dizajnu

Statický redakčný kontrolný zoznam

Použite viditeľné nezaškrtnuté ovládacie prvky pre tlačiteľný alebo referenčný kontrolný zoznam. Čitateľ si ho môže skopírovať alebo vytlačiť, ale stránka netvrdí, že ukladá pokrok.

Interaktívny kontrolný zoznam s pokrokom

Použite, keď čitateľ ťaží z označovania pokroku počas relácie. Oznámte počet bez presunu zamerania a poskytnite jasnú akciu na resetovanie.

Povinný a voliteľný kontrolný zoznam

Použite iba vtedy, keď voliteľné úlohy skutočne neovplyvňujú podmienku dokončenia. Označte voliteľné položky textom; nikdy sa nespoliehajte len na svetlejšiu farbu.

Zoskupený kontrolný zoznam

Pri viac ako desiatich celkových kontrolách rozdeľte prácu do skupín po štyroch až desiatich so samostatnými nadpismi a podmienkami dokončenia. Každá skupina je samostatne zrozumiteľná.

Stav tlače

Tlačový výstup musí zachovať prázdne a dokončené značky v čiernobielej farbe, ponechať štítky vedľa ich ovládacích prvkov a vyhnúť sa rozdeleniu krátkej skupiny cez strany.

Parametre

Počiatočná hodnota checked je určená pre vypracované príklady, uložené šablóny alebo stav úlohy vlastnený serverom. Redakčné kontrolné zoznamy začínajú nezaškrtnuté; autori nesmú nikdy predzaškrtnúť položku len preto, aby vytvorili atraktívnejší screenshot. Ak interactive=false, persist musí byť none.

Syntax a príklady kódu

Kanonické mapovanie sa riadi pravidlami priority, tela a vnorenej položky v základnej zmluve. Nadradený prvok poskytuje správanie kolekcie; každá položka poskytuje jeden štítok, voliteľný detail a stavové polia.

Prenosná direktíva Markdown

:::checklist{id="pre-publish-links" interactive=true persist=local}
## Pre-publish link check

Complete every required item before approving the page.

::item
### Open every internal link and confirm the destination exists
::

::item
### Confirm each anchor describes its destination out of context
::

::item{required=false}
### Check campaign parameters on optional promotional links
::

::item
### Verify keyboard focus is visible on every linked control
::

Complete when every required item passes and no exception remains.
:::

Hugo shortcode

{{< checklist id="pre-publish-links" title="Pre-publish link check" interactive="true" persist="local" completion="Complete when every required item passes and no exception remains." >}}
{{< checklist-item >}}Open every internal link and confirm the destination exists.{{< /checklist-item >}}
{{< checklist-item >}}Confirm each anchor describes its destination out of context.{{< /checklist-item >}}
{{< checklist-item required="false" >}}Check campaign parameters on optional promotional links.{{< /checklist-item >}}
{{< checklist-item >}}Verify keyboard focus is visible on every linked control.{{< /checklist-item >}}
{{< /checklist >}}

Toto je požadovaný tvar Hugo adaptéra, nie tvrdenie, že repozitár už poskytuje shortcode. Kým neexistuje registrovaný renderovací modul, použite sémantické HTML pre živý príklad namiesto napodobňovania komponentu nesúvisiacimi štýlmi.

WordPress blok

<!-- wp:amicited/checklist {"id":"pre-publish-links","title":"Pre-publish link check","interactive":true,"persist":"local","completion":"Complete when every required item passes and no exception remains."} -->
<!-- wp:amicited/checklist-item -->
<p>Open every internal link and confirm the destination exists.</p>
<!-- /wp:amicited/checklist-item -->
<!-- wp:amicited/checklist-item -->
<p>Confirm each anchor describes its destination out of context.</p>
<!-- /wp:amicited/checklist-item -->
<!-- wp:amicited/checklist-item {"required":false} -->
<p>Check campaign parameters on optional promotional links.</p>
<!-- /wp:amicited/checklist-item -->
<!-- wp:amicited/checklist-item -->
<p>Verify keyboard focus is visible on every linked control.</p>
<!-- /wp:amicited/checklist-item -->
<!-- /wp:amicited/checklist -->

Všetky adaptéry musia zachovať pôvodné poradie, stav povinnosti, viditeľné štítky, podmienku dokončenia a nezaškrtnutý obsah, keď nie sú k dispozícii skripty.

Príklady

Dobrý: ohraničená kontrola vydania

• Potvrďte, že verzia vydania sa zhoduje so schváleným záznamom o zmenách.
• Spustite zdokumentovaný smoke test a priložte jeho výsledok.
• Overte, že vlastník rollbacku je k dispozícii počas okna vydania.
• Zaznamenajte čas nasadenia do časovej osi incidentu.

Dokončené keď: všetky štyri záznamy sú prítomné a pomenovaný vlastník rollbacku potvrdil okno.

Funguje to, pretože každá položka začína pozorovateľnou akciou, zostáva v rámci jedného rozhodnutia o vydaní a má binárny dôkaz. Riadok dokončenia vysvetľuje, čo celá množina preukazuje.

Zlý: aspiratívny zoznam obsahu

• Premýšľajte o publiku.
• Urobte článok pútavým.
• Zlepšite SEO.
• Pridajte čokoľvek iné, čo pomôže.

Toto zlyháva, pretože žiadna z položiek nedefinuje podmienku úspešnosti, „čokoľvek iné“ robí množinu nekonečnou a zaškrtnutie políčok by nepreukázalo, že článok je pripravený. Nahraďte aspirácie overiteľnými bránami, ako napríklad „Uveďte jedno primárne publikum v zadaní“ alebo presuňte neakčné rady do prózy.

Schema značkovanie a prístupnosť

Neexistuje všeobecný typ Schema.org Checklist. Nemapujte nezávislé kontroly na HowToStep, pokiaľ stránka skutočne neopisuje usporiadaný postup a viditeľný obsah neobsahuje tieto kroky. Kontrolný zoznam môže zostať viditeľným obsahom v rámci Article, TechArticle, Product alebo iného odôvodneného typu stránky, ale jeho zaškrtávacie políčka nevytvárajú dodatočnú spôsobilosť pre schému.

Použite natívne <input type="checkbox"> ovládacie prvky pre interaktívny stav a priraďte každý ovládací prvok k <label> pomocou zbalenia alebo zodpovedajúcich hodnôt for a id. Statické zobrazenie, ktoré nemožno meniť, nesmie maskovať aktivovaný ovládací prvok. Použite neaktívne zaškrtávacie políčka pre explicitne neinteraktívny príklad alebo zoznam s textovými ekvivalentmi, ako napríklad „Nezaškrtnuté“ v kontextoch, kde by boli formulárové ovládacie prvky zavádzajúce.

Používatelia klávesnice musia dosiahnuť každé aktivované zaškrtávacie políčko v poradí zdroja, prepínať ho klávesom Space a vidieť trvalý indikátor zamerania. Po zaškrtnutí nepresúvajte zameranie. Ak sa aktualizuje správa o pokroku, oznámte stručné zhrnutie, napríklad „Štyri zo šiestich požadovaných položiek dokončené“ prostredníctvom slušnej živej oblasti; neoznamujte celý zoznam znova.

Zaškrtnuté a nezaškrtnuté stavy vyžadujú viac než len farbu. Pri zaškrtnutí ponechajte štítok namiesto jeho nahradenia textom „Hotovo,“ pretože akcia musí zostať identifikovateľná. Ak pokrok pretrváva, vysvetlite rozsah ukladania a poskytnite tlačidlo Resetovať pokrok. Užitočný obsah, indikátory povinnosti a podmienka dokončenia musia zostať v HTML vykreslenom na strane servera, keď JavaScript zlyhá.

Pravidlá písania

Položky kontrolného zoznamu sú kompaktné, pretože čitateľ vykonáva alebo overuje, nie sa učí celú tému v rámci ovládacieho prvku. Dôvod vysvetlite v okolitej próze pred stanovením pravidla.

• Udržujte jeden kontrolný zoznam na štyroch až desiatich položkách. Štyri vytvárajú užitočnú konečnú množinu; viac ako desať sa stáva ťažko prehľadným a signalizuje viacero fáz.
• Udržujte každú akciu na asi 80 znakoch a tri až dvanásť slov. Krátky štítok zostáva použiteľný vedľa ovládacieho prvku a extrahovateľný bez okolitej prózy.
• Začnite konkrétnym rozkazovacím slovesom: Potvrďte, Otvorte, Porovnajte, Zaznamenajte, Otestujte, Priložte alebo Overte. Vyhnite sa slabým slovesám ako Zvážte, Pamätajte alebo Premýšľajte o.
• Každá položka nech má jednu podmienku úspešnosti. „Skontrolujte názov a odkazy“ môže byť splnené čiastočne, preto ho rozdeľte na dve položky.
• Udržujte položky nezávislé. Ak jedna akcia odomyká ďalšiu, preveďte postup na kroky a kontrolný zoznam použite len na konečné overenie.
• Udržujte gramatiku a úroveň paralelné. Nemiešajte „Potvrďte právne schválenie“ s „Publikujte kampaň vo všetkých kanáloch a monitorujte ju týždeň.“
• Uveďte dôkaz, keď dokončenie nie je priamo viditeľné: priložte správu, zaznamenajte časovú pečiatku alebo získajte potvrdenie od schvaľovateľa.
• Označte voliteľné položky explicitne a vylúčte ich z požadovaného pokroku. Voliteľné musí znamenať, že podmienka dokončenia zostáva pravdivá aj bez nich.
• Dôsledne používajte veľkosť písma vety a koncové interpunkčné znamienka. Plné vety sú preferované, keď položka obsahuje kvalifikátor.

Nikdy neumiestňujte tieto veci do položky kontrolného zoznamu:

• Niekoľko usporiadaných podkrokov, vetviacu sa logiku riešenia problémov alebo druhý vnorený kontrolný zoznam.
• Bezpečnostné varovanie, právne vylúčenie zodpovednosti alebo nezvratný následok, ktorý musí byť videný pred akciou.
• Odsek vysvetlenia, dlhú citáciu, svedectvo, screenshot, video, formulár alebo propagačnú výzvu na akciu.
• Subjektívne skóre, otvorenú ambíciu, nepodložený prah alebo požiadavku bez pozorovateľného dôkazu.
• Odkaz označený iba „tu,“ pretože položka musí prežiť extrakciu bez okolitého kontextu.

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

Prepojenia nižšie sú riadené frontmatterom postTypes tejto stránky. „Povinné“ znamená, že kľúčová úloha typu príspevku závisí od konečného modelu dokončenia; „odporúčané“ a „voliteľné“ závisia od témy stránky.

QA kontrolný zoznam

Obsah a umiestnenie

• Nadpis pomenúva jeden ohraničený objekt, rozhodnutie alebo stav pripravenosti.
• Úvod vysvetľuje, čo dokončenie požadovaných položiek preukazuje.
• Použite štyri až desať položiek, rozdeľte väčšiu prácu do pomenovaných skupín.
• Udržujte každú položku okolo 80 znakov a začnite konkrétnym slovesom.
• Každá položka má jednu pozorovateľnú podmienku úspešnosti a môže byť skontrolovaná nezávisle.
• Potvrďte, že preskupenie položiek nenarúša úlohu.
• Množina je konečná a obsahuje všetky požadované brány pre svoj deklarovaný rozsah.
• Voliteľné položky sú viditeľne označené a vylúčené z požadovaného pokroku.
• Odstráňte vnorené postupy, varovania, dlhé vysvetlenia, médiá a propagáciu.

Dokončené keď: kolekcia má jeden ohraničený účel a každá položka je stručná, nezávislá a overiteľná.

Vykreslenie a prístupnosť

• Podmienka dokončenia sa objaví priamo za poslednou položkou.
• Aktivované ovládacie prvky majú priradené štítky, klávesnicové ovládanie a viditeľné zameranie.
• Stav nie je komunikovaný iba farbou, ikonami, prečiarknutím alebo pozíciou.
• Interaktívny pokrok funguje bez presunu zamerania a vysvetľuje prípadnú trvácnosť.
• Štítky a kritériá dokončenia zostávajú dostupné bez CSS alebo JavaScriptu.
• Udržujte štruktúrované dáta na obklopujúcej stránke; nevymýšľajte schému Checklist.
• Zachovajte rovnaké polia a poradie vo všetkých troch mapovaniach platforiem.
• Ponechajte komentáre k screenshotom ako inštrukcie; neodkazujte na chýbajúci obrázok.

Dokončené keď: stav, štítky, poradie a význam dokončenia prežijú každú podporovanú cestu vykreslenia.

FAQ

Akademická šablóna vykresľuje päť recenzovaných otázok z frontmatteru [[faq]] tejto stránky. Pokrývajú počet položiek, odlíšenie od odrážok a krokov, uložený stav a štruktúrované dáta.