Checklist: schrijfregels, plaatsing en voorbeelden
Bouw checklists met afgebakende acties, duidelijke voltooiingsintentie, toegankelijke afvinkbare statussen en een structuur die zoekmachines en AI-systemen betrouwbaar kunnen extraheren.
Een checklist is een eindige set onafhankelijke acties of verificatiemomenten die een lezer als onvolledig of volledig kan markeren. De afvinkbare status maakt deel uit van de betekenis: het voltooien van elk vereist item moet bewijzen dat een benoemde taak, controle of gereedheidsconditie is afgerond.
Linkcontrole voor publicatie
Voer alle vier controles uit voordat je de pagina goedkeurt.
Voltooid wanneer: elk item slaagt en er geen niet-aangevinkte uitzondering overblijft.
Dit weergegeven voorbeeld heeft een afgebakende reikwijdte, vier beknopte acties, zichtbare niet-aangevinkte statussen en één voltooiingsvoorwaarde. Dezelfde woorden omzetten naar decoratieve bullets zou de belofte wegnemen dat de set kan worden afgerond.
Waarom dit element belangrijk is
Lezers gebruiken een checklist om hun geheugen te ontlasten. In plaats van elke vereiste in gedachten te houden terwijl ze schakelen tussen een concept, browser, ontwerp en publicatie-interface, kunnen ze één voorwaarde tegelijk inspecteren en voortgang bijhouden. De eindige grens vermindert onzekerheid: de lezer weet wat er nog moet gebeuren, wat ‘klaar’ betekent en wanneer het veilig is om verder te gaan.
Dat psychologische contract is sterker dan ‘hier zijn wat nuttige ideeën.’ Een checkbox nodigt uit tot betrokkenheid, terwijl het laatste niet-aangevinkte item bewuste spanning creëert. Het element moet daarom eerlijk zijn over de reikwijdte. Als de lijst een vereiste controle overslaat of vage ambities bevat zoals ‘maak de pagina geweldig,’ geeft de interface een zekerheidssignaal dat de inhoud niet heeft verdiend.
Machine-extraheerbaarheid is het vermogen van zoekmachines, AI-antwoordsystemen, ondersteunende technologie en publicatietools om elk item te isoleren zonder de rol of het voltooiingsmodel te verliezen. Een getypeerde checklist geeft een benoemde verzameling, stabiele itemgrenzen, beginstatussen en een voltooiingsvoorwaarde weer. Een parser kan vereiste controles onderscheiden van voorbeelden of voordelen, terwijl een AI-systeem één zelfstandige actie kan citeren met het onderwerp van de checklist intact.
Volg de schrijfregels voor elementen voordat je de component kiest. Hun voorrangsregel is semantisch: wanneer het doel van een blok is om te worden voltooid of geverifieerd, gebruik dan het checklistelement, zelfs als gewone bullets dezelfde woorden zouden kunnen weergeven. Visuele gelijkenis behoudt geen status, validatie, toegankelijkheid of adaptermapping.
Wanneer gebruik je het
Gebruik een checklist wanneer de set eindig is, elk item onafhankelijk kan slagen of falen en het voltooien van de vereiste items een betekenisvolle toestand creëert. Geschikte onderwerpen zijn onder meer pre-publicatiecontrole, inkoopvereisten, migratiegereedheid, incidentoverdracht, documentvolledigheid, toegankelijkheidscontrole en terugkerend onderhoudsinspectie.
Pas drie tests toe:
- Statustest: Kan elk item ondubbelzinnig als onvolledig of volledig worden gemarkeerd?
- Grenstest: Bevat de lijst alle vereiste controles voor de aangegeven reikwijdte?
- Voltooiingstest: Bewijst het afronden van de vereiste items een benoemd resultaat?
Als het antwoord op een vraag nee is, is een ander element waarschijnlijk nauwkeuriger. De veelvoorkomende bijna-missen zijn:
- Een bulletlijst groepeert feiten, opties, voorbeelden of kenmerken. De items zijn geen taken en de set wordt niet volledig.
- Een stappenlijst codeert afhankelijke volgorde. Als het verplaatsen van item 4 naar vóór item 2 tot falen kan leiden, zijn nummers en herstelinstructies belangrijker dan checkboxen.
- Een functielijst beschrijft wat een product heeft. ‘Ondersteunt CSV-export’ is geen controle tenzij de lezer een gestelde vereiste verifieert.
- Een verlanglijst registreert voorkeuren waarvan de grenzen en prioriteit kunnen veranderen. Het mag geen voltooiing beloven.
- Een scorekaart evalueert dimensies op een schaal. Binaire checkstatussen zouden nuttige prestatieniveaus weggooien.
- Een lange procedure met een checkbox naast elke klik verwart uitvoering met verificatie. Leg de procedure uit als stappen en voeg vervolgens een korte voltooiingschecklist toe.
Gebruik een checklist niet als decoratie aan het einde van elke sectie. Herhaalde niet-aangevinkte vakjes leggen werk op en impliceren dat de lezer nog niet klaar is, zelfs als de inhoud slechts optioneel advies bood.
Waar plaats je het
Plaatsing volgt het moment waarop de lezer kan handelen of verifiëren. Introduceer eerst de taak, reikwijdte en vereiste context; plaats de checklist vervolgens direct vóór de beslissing die hij controleert of direct na het materiaal dat hij samenvat.
- Zet een gereedheidschecklist na vereisten en vóór een onomkeerbare of kostbare actie.
- Zet een kwaliteitsborgingschecklist na het concept, de configuratie of de procedure die het evalueert en vóór goedkeuring of publicatie.
- Zet een inkoopvereistenchecklist nadat behoeften en beperkingen zijn uitgelegd maar voordat producten worden geselecteerd.
- Zet een terugkerende inspectiechecklist in de onderhoudssectie, naast de frequentie en verantwoordelijke.
- Zet de hoofdchecklist bovenaan een speciaal checklistartikel, na een korte reikwijdteverklaring, en leg vervolgens moeilijke items eronder uit.
Een checklist mag niet direct naast een tweede checklist met overlappende reikwijdte staan; voeg ze samen of geef elk een eigen kop en voltooiingsvoorwaarde. Plaats het niet naast een sequentiële stappenlijst zonder aan te geven welk blok de procedure is en welk de verificatie. Het mag een waarschuwing niet splitsen van het gevolg of de vereiste reactie, een vergelijkingstabel niet onderbreken, of in een call-to-action staan. Plaats nooit een promotionele knop tussen het laatste item en de voltooiingsvoorwaarde.
Anatomie
De gelabelde regio’s zijn:
- Reikwijdtekop: benoemt het exacte object en de beslissing, zoals ‘Linkcontrole voor publicatie.’
- Instructie: zegt wat voltooiing mogelijk maakt of bewijst.
- Checkbox-besturingselement: geeft de onvolledige of volledige status programmatisch en visueel weer.
- Actielabel: begint met een concreet werkwoord en blijft op zichzelf begrijpelijk.
- Optionele kwalificatie: geeft een drempel, locatie, verantwoordelijke of bewijseis.
- Vereist-indicator: onderscheidt optionele items alleen wanneer het contract ze echt toestaat.
- Voortgangsoverzicht: rapporteert voltooide en totale vereiste items in interactieve varianten.
- Voltooiingsvoorwaarde: geeft het resultaat aan dat wordt bereikt wanneer alle vereiste items slagen.
De woorden blijven gezaghebbend. Een vinkpictogram, groene rij of doorgestreept label kan status versterken, maar geen daarvan kan de native of programmatische aangevinkte status vervangen.
Ontwerpvoorbeelden
Statische redactionele checklist
Gebruik zichtbare niet-aangevinkte besturingselementen voor een afdrukbare of referentiechecklist. De lezer mag deze kopiëren of afdrukken, maar de pagina beweert geen voortgang op te slaan.
Interactieve voortgangschecklist
Gebruik dit wanneer de lezer baat heeft bij het markeren van voortgang tijdens een sessie. Kondig het aantal aan zonder focus te verplaatsen en bied een duidelijke resetactie.
Vereiste en optionele checklist
Gebruik dit alleen wanneer optionele taken de voltooiingsvoorwaarde echt niet beïnvloeden. Label optionele items in tekst; vertrouw nooit alleen op een lichtere kleur.
Gegroepeerde checklist
Verdeel het werk bij meer dan tien controles in groepen van vier tot tien met aparte koppen en voltooiingsvoorwaarden. Elke groep is zelfstandig begrijpelijk.
Afdrukstatus
Afdrukuitvoer moet lege en voltooide markeringen in zwart-wit behouden, labels naast hun besturingselementen houden en voorkomen dat een korte groep over pagina’s wordt gesplitst.
Parameters
| Naam | Type | Vereist | Min/max | Standaard | Bron | |
|---|---|---|---|---|---|---|
title | Platte tekst | Ja | 2–10 woorden; 90 tekens | Geen | Eerste kop in bovenliggende body | |
instruction | Platte tekst | Ja | 1 zin; 30 woorden | ‘Voltooi elk vereist item.’ | Body na eerste kop | |
items | Herhaalde itemcollectie | Ja | 4–10 per groep | Geen | Geneste itembodies | |
item.label | Platte inline tekst | Ja | 3–12 woorden; ongeveer 80 tekens max | Eerste kop in itembody | Eerste kop | |
item.detail | Beperkte Markdown | Nee | 0–1 zin; 140 tekens | Weggelaten | Itembody na eerste kop | |
item.required | Boolean | Nee | true of false | true | Itemattribuut | |
item.checked | Boolean | Nee | true of false | false | Itemattribuut; alleen geschreven voorbeelden | |
interactive | Boolean | Nee | true of false | false | Bovenliggend attribuut | |
persist | Enum | Nee | none, local of account | none | Bovenliggend attribuut | |
completion | Platte tekst | Ja | 1 zin; 25 woorden | Geen | Laatste alinea in bovenliggende body | |
id | Kleine letters identifier | Voorwaardelijk | Uniek op pagina; 2–8 afgebroken woorden | Gegenereerd, daarna vastgezet | Bovenliggend attribuut |
De initiële checked-waarde is voor uitgewerkte voorbeelden, opgeslagen sjablonen of server-eigen taakstatus. Redactionele checklists beginnen niet-aangevinkt; auteurs mogen nooit een item vooraf aanvinken alleen om een aantrekkelijkere screenshot te maken. Als interactive=false, moet persist none zijn.
Syntax en codevoorbeelden
De canonieke mapping volgt de voorrangs-, body- en geneste-itemregels in het basiscontract. Het bovenliggende element zorgt voor collectiegedrag; elk item levert één label, optionele details en statusvelden.
Portable Markdown-richtlijn
:::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 >}}
Dit is de vereiste Hugo-adaptervorm, geen bewering dat de repository de shortcode al levert. Totdat een geregistreerde renderer bestaat, gebruik je semantische HTML voor een live voorbeeld in plaats van de component te imiteren met niet-gerelateerde stijlen.
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 -->
Alle adapters moeten brondervolgorde, vereiste status, zichtbare labels, de voltooiingsvoorwaarde en de niet-aangevinkte inhoud behouden wanneer scripting niet beschikbaar is.
Voorbeelden
Goed: een afgebakende releasecontrole
- Bevestig dat de releaseversie overeenkomt met het goedgekeurde wijzigingsrapport.
- Voer de gedocumenteerde smoketest uit en voeg het resultaat toe.
- Controleer of de rollback-eigenaar beschikbaar is tijdens het releasevenster.
- Noteer de implementatietijd in de incidenttijdlijn.
Voltooid wanneer: alle vier de registraties aanwezig zijn en de genoemde rollback-eigenaar het venster heeft bevestigd.
Dit werkt omdat elk item begint met een waarneembare actie, binnen één releasebeslissing blijft en binair bewijs heeft. De voltooiingsregel legt uit wat de volledige set bewijst.
Slecht: een ambitieuze inhoudslijst
- Denk aan het publiek.
- Maak het artikel boeiend.
- Verbeter SEO.
- Voeg iets anders toe dat helpt.
Dit faalt omdat geen van de items een slaagvoorwaarde definieert, ‘iets anders’ de set oneindig maakt en het afvinken van de vakjes niet zou bewijzen dat het artikel klaar is. Vervang ambities door verifieerbare controles zoals ‘Noem één primair publiek in de briefing’ of verplaats niet-uitvoerbare richtlijnen naar proza.
Schema-markup en toegankelijkheid
Er is geen algemeen Schema.org-type Checklist. Wijs onafhankelijke controles niet toe aan HowToStep tenzij de pagina daadwerkelijk een geordende procedure beschrijft en de zichtbare inhoud die stappen bevat. Een checklist kan zichtbare inhoud blijven binnen Article, TechArticle, Product of een ander gerechtvaardigd paginatype, maar de checkboxen creëren geen extra schema-gerechtigdheid.
Gebruik native <input type="checkbox">-besturingselementen voor interactieve status en koppel elk besturingselement aan een <label> via omhulling of overeenkomende for- en id-waarden. Een statische weergave die niet kan worden gewijzigd, mag zich niet voordoen als een ingeschakeld besturingselement. Gebruik uitgeschakelde checkboxen voor een expliciet niet-interactief voorbeeld, of gebruik een lijst met tekstuele equivalenten zoals ‘Niet aangevinkt’ in contexten waar formulierbesturingselementen misleidend zouden zijn.
Toetsenbordgebruikers moeten elk ingeschakeld checkboxbereiken in brondervolgorde, deze kunnen schakelen met de Spatiebalk en een blijvende focusindicator zien. Verplaats focus niet na een controle. Als een voortgangsbericht wordt bijgewerkt, kondig dan een beknopte samenvatting aan zoals ‘Vier van zes vereiste items voltooid’ via een beleefd live-gebied; kondig niet de hele lijst opnieuw aan.
Aangevinkte en niet-aangevinkte statussen vereisen meer dan kleur. Behoud het label bij aanvinken in plaats van het te vervangen door ‘Gereed,’ omdat de actie herkenbaar moet blijven. Als voortgang blijft bestaan, leg dan de opslagomvang uit en bied ‘Reset voortgang’ aan. De bruikbare inhoud, vereiste indicatoren en voltooiingsvoorwaarde moeten in server-gerenderde HTML blijven wanneer JavaScript faalt.
Schrijfregels
Checklistitems zijn compact omdat de lezer aan het uitvoeren of verifiëren is, niet de hele inhoud binnen het besturingselement aan het leren. Leg de reden uit in omringend proza voordat je de regel geeft.
- Houd één checklist op vier tot tien items. Vier vormt een bruikbare eindige set; meer dan tien wordt moeilijk te scannen en duidt op meerdere fases.
- Houd elke actie op ongeveer 80 tekens en drie tot twaalf woorden. Een kort label blijft bruikbaar naast een besturingselement en extraheerbaar zonder omliggend proza.
- Begin met een specifiek gebiedend werkwoord: Bevestig, Open, Vergelijk, Noteer, Test, Voeg toe of Controleer. Vermijd zwakke werkwoorden zoals Overweeg, Onthoud of Denk aan.
- Geef elk item één slaagvoorwaarde. ‘Controleer de titel en links’ kan gedeeltelijk slagen, dus splits het in twee items.
- Houd items onafhankelijk. Als één actie de volgende ontgrendelt, converteer de procedure dan naar stappen en gebruik de checklist alleen voor eindverificatie.
- Houd grammatica en abstractieniveau parallel. Meng niet ‘Bevestig wettelijke goedkeuring’ met ‘Publiceer de campagne op alle kanalen en monitor deze een week.’
- Noem bewijs wanneer voltooiing niet direct zichtbaar is: voeg het rapport toe, noteer het tijdstempel of verkrijg de bevestiging van de goedkeurder.
- Markeer optionele items expliciet en sluit ze uit van vereiste voortgang. Optioneel moet betekenen dat de voltooiingsvoorwaarde ook zonder hen waar blijft.
- Gebruik kleine letters na de punt en consistente interpunctie. Volledige zinnen hebben de voorkeur wanneer een item een kwalificatie bevat.
Plaats nooit het volgende in een checklistitem:
- Verschillende geordende substappen, vertakkende probleemoplossingslogica of een tweede geneste checklist.
- Een veiligheidswaarschuwing, juridische disclaimer of onomkeerbaar gevolg dat vóór actie moet worden gezien.
- Een alinea uitleg, lang citaat, getuigenis, screenshot, video, formulier of promotionele call-to-action.
- Een subjectieve score, open einde ambitie, niet-onderbouwde drempel of vereiste zonder waarneembaar bewijs.
- Een link die alleen ‘hier’ als label heeft, omdat het item extractie moet overleven zonder omringende context.
Berichttypen die het gebruiken
De onderstaande koppelingen worden aangestuurd door de postTypes-frontmatter van deze pagina. ‘Vereist’ betekent dat de kerntaak van het berichttype afhangt van een eindig voltooiingsmodel; ‘aanbevolen’ en ‘optioneel’ hangen af van het onderwerp van de pagina.
| Berichttype | Gebruik | Voorkeurspositie | Speciale regel | |
|---|---|---|---|---|
| How-to-gids | Aanbevolen als eindverificatie | Na de geordende procedure, vóór volgende stappen | Herhaal niet elke stap; controleer uitkomsten en slaagvoorwaarden. | |
| Checklistartikel | Vereist als primair element | Na reikwijdte en vereisten, vóór itemuitleg | Zet de complete bruikbare checklist vóór commentaar op moeilijke items. | |
| Probleemoplossingsartikel | Aanbevolen voor herstelverificatie | Na de oplossing, vóór escalatie of preventie | Controleer symptomen en systeemstatus; codeer diagnostische vertakkingen niet als controles. | |
| Koopgids | Optioneel voor vastleggen vereisten | Na behoeften en beperkingen, vóór de shortlist | Scheid vereiste criteria van voorkeuren en vink leveranciersclaims niet vooraf aan. | |
| Documentatieartikel | Aanbevolen voor installatie- of releasegereedheid | Na vereisten of procedure, direct vóór de gecontroleerde actie | Controles moeten overeenkomen met de huidige interface, versie en machtigingen. | |
| Beleidspagina | Optioneel voor implementatiebewijs | Na de leidende vereiste, vóór uitzonderingen of contactpersonen | De beleidstekst blijft gezaghebbend; de checklist kan deze niet versmallen. | |
| Norm- of regelgevingspagina | Optioneel voor gedocumenteerde nalevingsbeoordeling | Nadat toepasselijkheid en vereisten zijn uitgelegd | Onderscheid wettelijke vereisten van redactionele implementatierichtlijnen. | |
| Sjabloonbericht | Aanbevolen voor voltooiingsbeoordeling | Na het herbruikbare sjabloon en veldinstructies | Controleer het voltooide artefact, niet of de lezer het heeft gedownload. |
QA-checklist
Inhoud en plaatsing
- De kop benoemt één afgebakend object, beslissing of gereedheidstoestand.
- De inleiding legt uit wat het voltooien van de vereiste items bewijst.
- Gebruik vier tot tien items, splits groter werk in benoemde groepen.
- Houd elk item rond de 80 tekens en begin met een concreet werkwoord.
- Elk item heeft één waarneembare slaagvoorwaarde en kan onafhankelijk worden gecontroleerd.
- Bevestig dat het herordenen van items de taak niet verbreekt.
- De set is eindig en bevat elke vereiste controle voor de aangegeven reikwijdte.
- Optionele items zijn zichtbaar gelabeld en uitgesloten van vereiste voortgang.
- Verwijder geneste procedures, waarschuwingen, lange uitleg, media en promotie.
Voltooid wanneer: de verzameling één afgebakend doel heeft en elk item beknopt, onafhankelijk en verifieerbaar is.
Weergave en toegankelijkheid
- De voltooiingsvoorwaarde verschijnt direct na het laatste item.
- Ingeschakelde besturingselementen hebben bijbehorende labels, toetsenbordbediening en zichtbare focus.
- Status wordt niet alleen gecommuniceerd door kleur, pictogrammen, doorhaling of positie.
- Interactieve voortgang werkt zonder focus te verplaatsen en legt eventuele persistentie uit.
- Labels en voltooiingscriteria blijven beschikbaar zonder CSS of JavaScript.
- Houd gestructureerde data op de omringende pagina; verzin geen Checklist-schema.
- Behoud dezelfde velden en volgorde in alle drie platformmappings.
- Houd screenshotcommentaar als instructies; verwijs naar geen ontbrekende afbeelding.
Voltooid wanneer: status, labels, volgorde en voltooiingsbetekenis elke ondersteunde weergavepad overleven.
FAQ
De academiesjabloon geeft de vijf beoordeelde vragen in de [[faq]]-frontmatter van deze pagina weer. Ze behandelen het aantal items, het onderscheid van bullets en stappen, opgeslagen status en gestructureerde data.
Meer tutorials in deze sectie
Klaar om het in de praktijk te brengen?
Gratis check · 7 dagen proefperiode · geen creditcard nodig