Skip to main content
Introducing packages.sweber.dev
Documentation menuManual checklist

Manual checklist

Work through the WCAG 2.2 A/AA success criteria that automated tests cannot cover.

Automated rules find only part of the barriers. @weber-development/surjection-checklist guides the manual part: the 55 success criteria of WCAG 2.2 level A and AA, each with a short instruction in English, German, Swiss German, French and Italian (--locale en|de|de-CH|fr|it). The editor, the Markdown list and the client report follow the language.

npx surjection-checklist init --project "Muster AG"
npx surjection-checklist apply --checklist checklist.json --results a11y.json
npx surjection-checklist edit --checklist checklist.json --locale de --out checklist.html
npx surjection-checklist status --checklist checklist.json

Commands

CommandWhat it does
initCreates checklist.json for a project (--level A or AA, default AA)
applyMarks criteria with automated findings as failed. It never marks a criterion as passed, because automated rules cover only part of it
editWrites a self-contained HTML page. Set each criterion to passed, failed or not applicable, add notes, then download the updated checklist.json
statusPrints how many criteria are untested, passed, failed and not applicable
retestAfter a re-test: criteria that failed only because of automated findings and have none left go back to untested, with a note. A person confirms the fix by hand; automated tests never mark a criterion as passed. Criteria you failed yourself stay failed
markdownWrites the checklist as Markdown
statementWrites the conformance status and known issues for the accessibility statement

The editor saves your progress in the browser until you download the file. It works offline and sends nothing anywhere.

Evidence and reviewer

For every criterion the editor has a note, the name of the person who tested ("Tested by"), the date (set when you decide), evidence links or references (one per line: a ticket, a video, a file name) and screenshots as evidence (PNG, JPEG, WebP or GIF, up to 400 KB each). Images are stored inside checklist.json, so the file stays self-contained. Reports show links and images next to each criterion; only https links are made clickable. The Markdown list and the Word report name the evidence.

Into the statement and the report

npx surjection-checklist statement --checklist checklist.json --locale de --out statement-fields.json

Merge the fields into your statement config and run surjection statement, or skip the merge and pass the checklist directly: surjection statement --config statement.json --checklist checklist.json --out erklaerung.html. Pass the checklist to the report with --checklist to include it as a section.

statement refuses to run while criteria are still untested. The status is "fully conformant" only when no criterion failed, and every failed criterion becomes a known issue (your note, or the criterion title). Whether the result holds remains your judgement as the tester.