Skip to content

Operational Templates

fecarrico edited this page Jul 4, 2026 · 2 revisions

Operational Templates

A11Y.md provides two templates in the templates/ folder: REPORT.md and EXCEPTIONS.md.

These are not documentation files for you to read. They are active process tools meant to be integrated into your development lifecycle, acting as the bridge between the AI's generated code and human validation.

1. REPORT.md (The QA Checklist)

While the AI can generate accessible code, accessibility ultimately requires human validation. You cannot automate empathy or perceptual testing with 100% accuracy.

Before merging a Pull Request (PR) for a new feature, a developer should copy the REPORT.md template into the PR description or ticket.

It forces the developer to manually verify the 5-step workflow:

  • The linter passes.
  • The Tab key was manually tested.
  • Screen reader feedback was verified for dynamic events.
  • 400% zoom does not break the layout.
  • The interface is still understandable in grayscale.

2. EXCEPTIONS.md (The Debt Ledger)

This is the most critical template if you are using the Launchpad (A) Profile.

When a startup is moving fast, they might decide that implementing a 44x44px touch target on a dense dashboard will take too long because it requires a design overhaul. They consciously decide to accept the technical debt and use a 24x24px target.

The Rule: If you relax a visual criterion, you MUST document it in EXCEPTIONS.md.

Why is this powerful?

  1. Traceability: It proves that the team didn't just "forget" accessibility; they made a conscious, temporary business decision.
  2. Audit Defense: If a client asks for a VPAT (Accessibility Conformance Report), a populated EXCEPTIONS.md shows maturity and a roadmap for remediation.
  3. The AI Context: Because EXCEPTIONS.md lives in the repository, the AI knows what technical debt exists. When you eventually command the AI to "Upgrade our project from Launchpad to Standard Profile," it can read the EXCEPTIONS.md file and know exactly which components to refactor first.

Clone this wiki locally