Lista kontrolna: zasady pisania, umiejscowienie i przykłady

Lista kontrolna to skończony zestaw niezależnych działań lub punktów weryfikacji, które czytelnik może oznaczyć jako nieukończone lub ukończone. Jej możliwość odznaczania jest częścią znaczenia: ukończenie każdego wymaganego elementu powinno dowodzić, że nazwane zadanie, przegląd lub warunek gotowości został zakończony.

Ten renderowany przykład ma ograniczony zakres, cztery zwięzłe działania, widoczne stany niezaznaczone i jeden warunek ukończenia. Zamiana tych samych słów na dekoracyjne wypunktowanie usunęłoby obietnicę, że zestaw można zakończyć.

Dlaczego ten element jest ważny

Czytelnicy używają listy kontrolnej, aby odciążyć pamięć. Zamiast trzymać w głowie wszystkie wymagania podczas przełączania się między szkicem, przeglądarką, projektem i interfejsem publikacji, mogą sprawdzać jeden warunek na raz i rejestrować postępy. Ograniczony zakres zmniejsza niepewność: czytelnik wie, co pozostało, co oznacza „gotowe" i kiedy można bezpiecznie przejść dalej.

Ta psychologiczna umowa jest silniejsza niż „oto kilka przydatnych pomysłów". Pole wyboru zachęca do zaangażowania, a ostatni niezaznaczony element tworzy zamierzone napięcie. Element musi zatem być uczciwy co do zakresu. Jeśli lista pomija wymagany punkt kontrolny lub zawiera niejasne aspiracje, takie jak „zrób stronę świetną", interfejs sygnalizuje pewność, której treść nie zdobyła.

Możliwość ekstrakcji maszynowej to zdolność wyszukiwarek, systemów odpowiedzi AI, technologii asystujących i narzędzi wydawniczych do wyodrębnienia każdego elementu bez utraty jego roli lub modelu ukończenia. Typowana lista kontrolna udostępnia nazwaną kolekcję, stabilne granice elementów, stany początkowe i warunek ukończenia. Parser może odróżnić wymagane punkty kontrolne od przykładów lub korzyści, a system AI może zacytować jedno samodzielne działanie z zachowaniem tematu listy kontrolnej.

Przed wyborem komponentu postępuj zgodnie z zasadami pisania elementów . Ich reguła pierwszeństwa jest semantyczna: jeśli celem bloku jest ukończenie lub weryfikacja, użyj elementu listy kontrolnej, nawet jeśli zwykłe wypunktowanie mogłoby wyświetlić te same słowa. Wizualne podobieństwo nie zachowuje stanu, walidacji, dostępności ani mapowania adaptera.

Kiedy go używać

Użyj listy kontrolnej, gdy zestaw jest skończony, każdy element może niezależnie przejść lub nie zdać, a ukończenie wymaganych elementów ustanawia znaczący warunek. Odpowiednie tematy obejmują przegląd przed publikacją, wymagania dotyczące zamówień, gotowość migracji, przekazanie incydentu, kompletność dokumentów, przegląd dostępności i powtarzalną kontrolę konserwacyjną.

Zastosuj trzy testy:

1. Test stanu: Czy każdy element może być jednoznacznie oznaczony jako nieukończony lub ukończony?
2. Test granicy: Czy lista zawiera wszystkie wymagane kontrole dla swojego deklarowanego zakresu?
3. Test ukończenia: Czy ukończenie wymaganych elementów dowodzi nazwanego wyniku?

Jeśli odpowiedź na którekolwiek pytanie brzmi „nie", inny element jest prawdopodobnie bardziej odpowiedni. Najczęstsze pomyłki to:

• Lista wypunktowana grupuje fakty, opcje, przykłady lub atrybuty. Jej elementy nie są zadaniami, a zestaw nie staje się kompletny.
• Lista kroków koduje zależną sekwencję. Jeśli przesunięcie elementu 4 przed element 2 może spowodować błąd, numeracja i wskazówki dotyczące odzyskiwania są ważniejsze niż pola wyboru.
• Lista funkcji opisuje, co posiada produkt. „Obsługuje eksport CSV" nie jest punktem kontrolnym, chyba że czytelnik weryfikuje określone wymaganie.
• Lista życzeń rejestruje preferencje, których granice i priorytet mogą się zmieniać. Nie powinna obiecywać ukończenia.
• Karta wyników ocenia wymiary w skali. Binarne stany zaznaczenia pominęłyby przydatne poziomy wydajności.
• Długa procedura z polem wyboru przy każdym kliknięciu myli wykonanie z weryfikacją. Wyjaśnij procedurę jako kroki, a następnie dodaj krótką listę kontrolną ukończenia.

Nie używaj listy kontrolnej jako dekoracji na końcu każdej sekcji. Powtarzające się niezaznaczone pola narzucają pracę i sugerują, że czytelnik nie skończył, nawet gdy treść jedynie oferowała opcjonalną poradę.

Gdzie ją umieścić

Umiejscowienie wynika z momentu, w którym czytelnik może działać lub weryfikować. Najpierw przedstaw zadanie, zakres i wymagany kontekst; następnie umieść listę kontrolną tuż przed decyzją, którą kontroluje, lub tuż po materiale, który podsumowuje.

• Umieść listę kontrolną gotowości po wymaganiach wstępnych i przed nieodwracalną lub kosztowną czynnością.
• Umieść listę kontrolną zapewnienia jakości po szkicu, konfiguracji lub procedurze, którą ocenia, i przed zatwierdzeniem lub publikacją.
• Umieść listę kontrolną wymagań zakupowych po wyjaśnieniu potrzeb i ograniczeń, ale przed sporządzeniem listy kandydatów.
• Umieść listę kontrolną powtarzalnej kontroli wewnątrz sekcji konserwacji, obok jej harmonogramu i osoby odpowiedzialnej.
• Umieść główną listę kontrolną blisko góry dedykowanego artykułu z listą kontrolną, po krótkim określeniu zakresu, a następnie wyjaśnij trudniejsze elementy poniżej.

Lista kontrolna nie może znajdować się bezpośrednio obok drugiej listy kontrolnej o pokrywającym się zakresie; połącz je lub nadaj każdej odrębny nagłówek i warunek ukończenia. Nie umieszczaj jej obok sekwencyjnej listy kroków bez określenia, który blok jest procedurą, a który weryfikacją. Nie może oddzielać ostrzeżenia od konsekwencji lub wymaganej reakcji, przerywać tabeli porównawczej ani znajdować się wewnątrz wezwania do działania. Nigdy nie umieszczaj przycisku promocyjnego między ostatnim elementem a warunkiem ukończenia.

Anatomia

Oznaczone regiony to:

1. Nagłówek zakresu: nazywa dokładny obiekt i decyzję, np. „Kontrola linków przed publikacją".
2. Instrukcja: określa, co ukończenie umożliwia lub czego dowodzi.
3. Kontrolka pola wyboru: udostępnia stan nieukończony lub ukończony programowo i wizualnie.
4. Etykieta działania: zaczyna się od konkretnego czasownika i pozostaje zrozumiała samodzielnie.
5. Opcjonalny kwalifikator: dostarcza próg, lokalizację, osobę odpowiedzialną lub wymóg dowodu.
6. Wskaźnik wymagalności: odróżnia elementy opcjonalne tylko wtedy, gdy umowa naprawdę na nie pozwala.
7. Podsumowanie postępu: raportuje ukończone i całkowite wymagane elementy w wariantach interaktywnych.
8. Warunek ukończenia: określa wynik osiągnięty, gdy wszystkie wymagane elementy przejdą pomyślnie.

Słowa pozostają autorytatywne. Ikona znacznika, zielony wiersz lub przekreślona etykieta mogą wzmacniać stan, ale żaden z nich nie może zastąpić natywnego lub programowego stanu zaznaczenia.

Przykłady projektowe

Statyczna edytorialna lista kontrolna

Użyj widocznych niezaznaczonych kontrolek do wydruku lub referencyjnej listy kontrolnej. Czytelnik może ją skopiować lub wydrukować, ale strona nie deklaruje zapisywania postępów.

Interaktywna lista kontrolna z postępem

Użyj, gdy czytelnik czerpie korzyści z oznaczania postępu podczas sesji. Ogłoś liczbę bez przesuwania fokusu i zapewnij wyraźną akcję resetowania.

Wymagana i opcjonalna lista kontrolna

Używaj tylko wtedy, gdy opcjonalne zadania naprawdę nie wpływają na warunek ukończenia. Oznacz opcjonalne elementy tekstem; nigdy nie polegaj na jaśniejszym kolorze.

Grupowana lista kontrolna

Dla więcej niż dziesięciu kontroli podziel pracę na grupy po cztery do dziesięciu z osobnymi nagłówkami i warunkami ukończenia. Każda grupa jest zrozumiała samodzielnie.

Stan wydruku

Wydruk musi zachować puste i wypełnione znaczniki w czerni i bieli, utrzymać etykiety obok ich kontrolek i unikać dzielenia krótkiej grupy między stronami.

Parametry

| title | Ciąg znaków | Tak | 2–10 słów; 90 znaków | Brak | Pierwszy nagłówek w treści nadrzędnej | | instruction | Tekst zwykły | Tak | 1 zdanie; 30 słów | „Wykonaj każdy wymagany element." | Treść po pierwszym nagłówku | | items | Kolekcja elementów | Tak | 4–10 na grupę | Brak | Zagnieżdżone treści elementów | | item.label | Tekst inline | Tak | 3–12 słów; maks. około 80 znaków | Pierwszy nagłówek w treści elementu | Pierwszy nagłówek | | item.detail | Ograniczony Markdown | Nie | 0–1 zdanie; 140 znaków | Pominięty | Treść elementu po pierwszym nagłówku | | item.required | Wartość logiczna | Nie | true lub false | true | Atrybut elementu | | item.checked | Wartość logiczna | Nie | true lub false | false | Atrybut elementu; tylko przykłady autorskie | | interactive | Wartość logiczna | Nie | true lub false | false | Atrybut nadrzędny | | persist | Wyliczenie | Nie | none, local lub account | none | Atrybut nadrzędny | | completion | Tekst zwykły | Tak | 1 zdanie; 25 słów | Brak | Ostatni akapit w treści nadrzędnej | | id | Identyfikator (małe litery) | Warunkowy | Unikalny na stronie; 2–8 słów z łącznikami | Generowany, następnie przypięty | Atrybut nadrzędny |

Początkowa wartość checked jest przeznaczona dla przykładowych rozwiązań, zapisanych szablonów lub stanów zadań należących do serwera. Edytorialne listy kontrolne zaczynają się niezaznaczone; autorzy nigdy nie powinni wstępnie zaznaczać elementu tylko po to, by stworzyć atrakcyjniejszy zrzut ekranu. Jeśli interactive=false, persist musi mieć wartość none.

Składnia i przykłady kodu

Kanoniczne mapowanie stosuje reguły pierwszeństwa, treści i zagnieżdżonych elementów z podstawowego kontraktu. Element nadrzędny zapewnia zachowanie kolekcji; każdy element dostarcza jedną etykietę, opcjonalny szczegół i pola stanu.

Przenośna dyrektywa 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.
:::

Shortcode Hugo

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

Jest to wymagany kształt adaptera Hugo, a nie twierdzenie, że repozytorium już udostępnia ten shortcode. Dopóki nie istnieje zarejestrowany renderer, używaj semantycznego HTML dla działającego przykładu, zamiast imitować komponent z niepowiązanymi stylami.

Blok WordPress

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

Wszystkie adaptery muszą zachować kolejność źródłową, stan wymagalności, widoczne etykiety, warunek ukończenia i niezaznaczoną treść, gdy skrypty są niedostępne.

Przykłady

Dobrze: ograniczona kontrola wydania

• Potwierdź, że wersja wydania jest zgodna z zatwierdzoną kartą zmian.
• Uruchom udokumentowany test dymny i załącz jego wynik.
• Sprawdź, czy osoba odpowiedzialna za wycofanie jest dostępna w oknie wydania.
• Zapisz czas wdrożenia w osi czasu incydentu.

Ukończono, gdy: wszystkie cztery rekordy są obecne, a wskazana osoba odpowiedzialna za wycofanie potwierdziła okno.

To działa, ponieważ każdy element zaczyna się od obserwowalnego działania, mieści się w jednej decyzji wydawniczej i ma binarny dowód. Wiersz ukończenia wyjaśnia, czego dowodzi pełny zestaw.

Źle: lista aspiracji treści

• Pomyśl o odbiorcach.
• Spraw, aby artykuł był angażujący.
• Popraw SEO.
• Dodaj wszystko inne, co pomoże.

To nie działa, ponieważ żaden z elementów nie definiuje warunku zaliczenia, „wszystko inne" czyni zestaw nieskończonym, a zaznaczenie pól nie dowodziłoby, że artykuł jest gotowy. Zastąp aspiracje weryfikowalnymi punktami kontrolnymi, takimi jak „Wskaż jedną główną grupę odbiorców w briefie" lub przenieś nieoperacyjne wskazówki do prozy.

Znaczniki Schema i dostępność

Nie ma ogólnego typu Checklist w Schema.org. Nie mapuj niezależnych kontroli na HowToStep, chyba że strona rzeczywiście opisuje uporządkowaną procedurę, a widoczna treść zawiera te kroki. Lista kontrolna może pozostać widoczną treścią wewnątrz Article, TechArticle, Product lub innego uzasadnionego typu strony, ale jej pola wyboru nie tworzą dodatkowej kwalifikacji schematu.

Używaj natywnych kontrolek <input type="checkbox"> dla stanu interaktywnego i powiąż każdą kontrolkę z <label> poprzez opakowanie lub dopasowane wartości for i id. Statyczny wyświetlacz, którego nie można zmienić, nie może udawać włączonej kontrolki. Używaj wyłączonych pól wyboru dla jawnie nieinteraktywnego przykładu lub listy z tekstowymi odpowiednikami, takimi jak „Niezaznaczone" w kontekstach, w których kontrolki formularza byłyby mylące.

Użytkownicy klawiatury muszą dotrzeć do każdego włączonego pola wyboru w kolejności źródłowej, przełączać je klawiszem Spacja i widzieć stały wskaźnik fokusu. Nie przesuwaj fokusu po zaznaczeniu. Jeśli komunikat o postępie jest aktualizowany, ogłoś zwięzłe podsumowanie, np. „Cztery z sześciu wymaganych elementów ukończone", poprzez uprzejmy region live; nie ogłaszaj całej listy ponownie.

Stany zaznaczone i niezaznaczone wymagają czegoś więcej niż kolor. Zachowaj etykietę po zaznaczeniu, zamiast zastępować ją słowem „Zrobione", ponieważ działanie musi pozostać identyfikowalne. Jeśli postępy są trwałe, wyjaśnij zakres przechowywania i zapewnij przycisk Resetuj postęp. Przydatna treść, wskaźniki wymagalności i warunek ukończenia muszą pozostać w renderowanym przez serwer HTML, gdy JavaScript zawiedzie.

Zasady pisania

Elementy listy kontrolnej są zwięzłe, ponieważ czytelnik wykonuje lub weryfikuje, a nie uczy się całego tematu wewnątrz kontrolki. Wyjaśnij powód w otaczającej prozie przed podaniem reguły.

• Zachowaj jedną listę kontrolną w zakresie od czterech do dziesięciu elementów. Cztery tworzą użyteczny skończony zestaw; więcej niż dziesięć staje się trudne do szybkiego przejrzenia i sygnalizuje wiele faz.
• Każde działanie zmieść w około 80 znakach i trzech do dwunastu słowach. Krótka etykieta pozostaje użyteczna obok kontrolki i możliwa do wyodrębnienia bez sąsiedniej prozy.
• Rozpoczynaj od konkretnego czasownika w trybie rozkazującym: Potwierdź, Otwórz, Porównaj, Zapisz, Przetestuj, Załącz lub Sprawdź. Unikaj słabych czasowników, takich jak Rozważ, Pamiętaj lub Pomyśl.
• Daj każdemu elementowi jeden warunek zaliczenia. „Sprawdź tytuł i linki" może być częściowo zaliczone, więc podziel to na dwa elementy.
• Zachowaj elementy niezależne. Jeśli jedno działanie odblokowuje następne, przekształć procedurę w kroki i użyj listy kontrolnej tylko do końcowej weryfikacji.
• Zachowaj równoległość gramatyki i poziomu ogólności. Nie mieszaj „Potwierdź zgodę prawną" z „Opublikuj kampanię we wszystkich kanałach i monitoruj ją przez tydzień".
• Określ dowód, gdy ukończenie nie jest bezpośrednio widoczne: załącz raport, zapisz znacznik czasu lub uzyskaj potwierdzenie osoby zatwierdzającej.
• Oznacz opcjonalne elementy jawnie i wyklucz je z wymaganego postępu. Opcjonalne musi oznaczać, że warunek ukończenia pozostaje spełniony bez nich.
• Używaj małych liter z wielką literą na początku i spójnej interpunkcji końcowej. Preferowane są pełne zdania, gdy element zawiera kwalifikator.

Nigdy nie umieszczaj wewnątrz elementu listy kontrolnej:

• Kilku uporządkowanych podkroków, rozgałęzionej logiki rozwiązywania problemów lub drugiej zagnieżdżonej listy kontrolnej.
• Ostrzeżenia bezpieczeństwa, zastrzeżenia prawnego lub nieodwracalnej konsekwencji, które muszą być zobaczone przed działaniem.
• Akapitu wyjaśnienia, długiego cytatu, referencji, zrzutu ekranu, wideo, formularza lub promocyjnego wezwania do działania.
• Subiektywnej oceny, otwartej aspiracji, nieuzasadnionego progu lub wymogu bez możliwych do zaobserwowania dowodów.
• Linku oznaczonego tylko „tutaj", ponieważ element musi przetrwać ekstrakcję bez otaczającego kontekstu.

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

Połączenia poniżej są określone przez postTypes w metadanych tej strony. „Wymagany" oznacza, że podstawowe zadanie typu posta zależy od skończonego modelu ukończenia; „zalecany" i „opcjonalny" zależą od tematu strony.

Lista kontrolna QA

Treść i umiejscowienie

• Nagłówek nazywa jeden ograniczony obiekt, decyzję lub stan gotowości.
• Wstęp wyjaśnia, czego dowodzi ukończenie wymaganych elementów.
• Użyj od czterech do dziesięciu elementów, dzieląc większą pracę na nazwane grupy.
• Każdy element utrzymuj w granicach 80 znaków i zaczynaj od konkretnego czasownika.
• Każdy element ma jeden obserwowalny warunek zaliczenia i może być sprawdzany niezależnie.
• Potwierdź, że zmiana kolejności elementów nie psuje zadania.
• Zestaw jest skończony i zawiera wszystkie wymagane punkty kontrolne dla swojego określonego zakresu.
• Opcjonalne elementy są widocznie oznaczone i wykluczone z wymaganego postępu.
• Usuń zagnieżdżone procedury, ostrzeżenia, długie wyjaśnienia, multimedia i promocje.

Ukończono, gdy: kolekcja ma jeden ograniczony cel, a każdy element jest zwięzły, niezależny i weryfikowalny.

Renderowanie i dostępność

• Warunek ukończenia pojawia się bezpośrednio po ostatnim elemencie.
• Włączone kontrolki mają powiązane etykiety, obsługę klawiatury i widoczny fokus.
• Stan nie jest przekazywany wyłącznie przez kolor, ikony, przekreślenie lub pozycję.
• Interaktywny postęp działa bez przesuwania fokusu i wyjaśnia ewentualną trwałość.
• Etykiety i kryteria ukończenia pozostają dostępne bez CSS i JavaScript.
• Utrzymuj dane strukturalne na otaczającej stronie; nie twórz schematu Checklist.
• Zachowaj te same pola i kolejność we wszystkich trzech mapowaniach platform.
• Pozostaw komentarze do zrzutów ekranu jako instrukcje; nie odwołuj się do brakującego obrazu.

Ukończono, gdy: stan, etykiety, kolejność i znaczenie ukończenia przetrwają każdą obsługiwaną ścieżkę renderowania.

FAQ

Szablon academy renderuje pięć przejrzanych pytań z metadanych [[faq]] tej strony. Obejmują one liczbę elementów, rozróżnienie między wypunktowaniem a krokami, zapisany stan i dane strukturalne.