Files
DevRunbook release export cfd2804e27
Managed validation / full (push) Successful in 3m18s
Publish DevRunbook source
2026-09-03 04:09:17 +02:00

214 lines
7.9 KiB
YAML

apiVersion: devrunbook.io/v1alpha1
kind: Playbook
metadata:
id: audits.accessibility-audit
slug: accessibility-audit
version: 1.0.0
title: Accessibility Audit
summary: Audit semantic structure, keyboard use, focus, forms, contrast, motion and assistive-technology behavior for selected
user flows.
category: audits
tags:
- accessibility
- wcag
- frontend
lifecycle: reviewed
riskTier: moderate
authors:
- name: DevRunbook Core Team
license: MIT
package:
files:
- path: prompt.md
role: template
digest: true
exportByDefault: false
- path: README.md
role: documentation
digest: true
exportByDefault: false
- path: CHANGELOG.md
role: changelog
digest: true
exportByDefault: false
- path: examples/minimal.yaml
role: example
digest: true
exportByDefault: false
- path: evaluations/static-structure.yaml
role: evaluation
digest: true
exportByDefault: false
spec:
type: guided
intent:
problem: Development work around accessibility audit is often underspecified, inconsistently executed or reported without
enough evidence.
outcome: Audit semantic structure, keyboard use, focus, forms, contrast, motion and assistive-technology behavior for
selected user flows.
whenToUse:
- Use this playbook when the repository needs a bounded accessibility audit task with explicit evidence and completion
criteria.
- Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
whenNotToUse:
- Do not use it when the desired outcome or authority boundaries are still materially undecided.
- Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
modes:
- inspect
- plan
defaultMode: inspect
autonomy:
min: observe
max: diagnose
default: diagnose
inputs:
- key: targetStandard
label: Target standard
description: Choose the accessibility target against which findings should be assessed.
type: enum
required: true
sensitive: false
includeInOutput: true
default: WCAG 2.2 AA
options:
- WCAG 2.2 A
- WCAG 2.2 AA
- WCAG 2.2 AAA
- EN 301 549
- key: criticalFlows
label: Critical flows
description: List the highest-value user or system flows that must be covered.
type: string-list
required: true
sensitive: false
includeInOutput: true
compatibility:
repositoryRequired: true
languages: []
frameworks: []
packageManagers: []
databases: []
deploymentTypes: []
requiredProfileCapabilities: []
incompatibleConditions: []
guardrails:
- id: guardrail-1
severity: blocking
text: Do not declare conformance from automated scans alone.
- id: guardrail-2
severity: blocking
text: Do not expose private user data in screenshots or reports.
- id: guardrail-3
severity: blocking
text: Separate confirmed failures, tool warnings and manual-review requirements.
workflow:
- id: define-target
title: Define audit target
instruction: Confirm the selected standard, user flows, supported input methods and representative content.
required: true
- id: automated-baseline
title: Run automated baseline
instruction: Use available accessibility tooling to identify machine-detectable issues without treating it as complete
coverage.
required: true
- id: keyboard-review
title: Review keyboard behavior
instruction: Verify focus order, visible focus, escape behavior, skip paths and keyboard completion of critical flows.
required: true
- id: semantics-review
title: Review semantics
instruction: Inspect headings, landmarks, labels, errors, live regions, tables and accessible names.
required: true
- id: visual-review
title: Review visual access
instruction: Check contrast, zoom, reflow, reduced motion, non-color cues and target sizes.
required: true
- id: assistive-review
title: Review assistive behavior
instruction: Perform available screen-reader or accessibility-tree checks and document untested combinations.
required: true
- id: prioritize
title: Prioritize remediation
instruction: Map findings to success criteria, user impact and practical repair sequence.
required: true
validation:
commandRoles:
- dev-start
- end-to-end-test
checks:
- id: check-1
type: assertion
description: Findings map to the selected standard and include user impact.
blocking: true
evidence: Referenced files, command results or explicit review notes.
- id: check-2
type: assertion
description: Automated, keyboard, semantic and visual evidence are reported separately.
blocking: true
evidence: Referenced files, command results or explicit review notes.
- id: command-dev-start
type: command
description: Run the resolved dev-start command when the repository profile provides it and record the result.
blocking: true
evidence: Resolved command, exit status and concise result summary.
- id: command-end-to-end-test
type: command
description: Run the resolved end-to-end-test command when the repository profile provides it and record the result.
blocking: true
evidence: Resolved command, exit status and concise result summary.
completion:
criteria:
- Issues include reproduction, affected users and remediation guidance.
- Automated and manual evidence are clearly separated.
- Validation evidence and unresolved limitations are reported honestly.
failurePolicy:
onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
affected validation and report any genuine blocker without claiming success.
onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
and stop before any material irreversible decision that the specification does not resolve.
onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
behavior or validation results; report what remains unavailable.
onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
recommendation.
onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
test. Otherwise record the blocked validation and do not claim the external path succeeded.
onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
changes; provide the narrowest next diagnostic action.
reporting:
sections:
- id: outcome
title: Outcome
required: true
description: State the delivered result or audit conclusion without overstating evidence.
- id: evidence
title: Evidence and scope
required: true
description: List inspected or changed areas and the evidence supporting the result.
- id: validation
title: Validation
required: true
description: Report commands, manual checks and their actual outcomes.
- id: risks
title: Risks and limitations
required: true
description: State residual risk, inaccessible evidence and untested conditions.
- id: follow-up
title: Recommended follow-up
required: true
description: List the smallest useful next actions or state None.
template:
main: prompt.md
partials: []
exports:
prompt: true
markdown: true
runPack: false
agentsSuggestion: false
quality:
reviewStatus: editorial-reviewed
testedStacks: []
knownLimitations:
- Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
evaluationCaseIds:
- accessibility-audit.static-structure