ACCESSIBILITY.md 怎么写:把无障碍目标与已知障碍写成可核查条目
一句话回答
ACCESSIBILITY.md 应把无障碍声明拆成目标、已知障碍、支持环境、贡献者期望、报告流程五类可核查信息;每条障碍要有编号、影响、环境、复现步骤和状态,避免“完全无障碍”“符合 WCAG”这类无法验证的表述。GitHub 对该文件的识别与展示细节以官方文档为准,本文材料未提供。
核心要点 TL;DR
- ACCESSIBILITY.md 的价值在于可核查,不在于措辞:每条写清影响对象、环境、复现方式与当前状态。
- 按五个区块组织:目标、已知障碍、支持环境、贡献者期望、报告流程。
- 状态只用“已确认 / 待核实 / 计划中”等可判定值,不写无法验证的合规承诺。
ACCESSIBILITY.md 是放在代码仓库里的无障碍声明:把“我们重视无障碍”拆成可被别人核查的条目。据 GitHub 博客 2026 年 11 月 5 日的文章,GitHub 现在会突出显示该文件,并帮助维护者记录无障碍目标、已知障碍、支持环境、贡献者期望和报告流程(来源)。GitHub 具体如何识别文件名、在哪些界面展示,本次材料未提供,待核实;写作时应以官方文档和仓库实际表现为准。
先划清文件边界#
- 一个仓库一份,声明对象是本仓库当前版本,不替代公司级法律声明或合规认证。
- 只写能验证的内容:能复现的障碍、能列出的测试环境、能指到的 issue。
- 不做无限承诺:修复时间、覆盖全部辅助技术的保证,材料无法支撑时就写“计划中”或“待核实”。
五个区块各自回答一个问题#
| 区块 | 回答的问题 | 可核查写法 |
|---|---|---|
| 无障碍目标 | 对齐什么标准、覆盖哪些使用场景 | 写明标准名称与版本,如 WCAG(Web Content Accessibility Guidelines,网页内容无障碍指南)2.2;未承诺的范围直接列出 |
| 已知障碍 | 哪里不能用、影响谁、怎么复现 | 一条一个编号,附环境、步骤、状态 |
| 支持环境 | 在哪些浏览器、读屏、平台上验证过 | 写组合与版本;没测过的写“未测试” |
| 贡献者期望 | 提交代码或文档时要做哪些无障碍检查 | 给可执行清单,如键盘走查、图片替代文本 |
| 报告流程 | 别人怎么报、由谁处理 | 写渠道、标题前缀、响应口径;无法承诺时限就说明 |
已知障碍:一条一个编号#
“部分组件对读屏不友好”无法核查。改成带编号的表格,让报告者、评审者和后续 issue 都能引用同一条记录。下面的 Markdown 是演示示例,未执行,也不代表官方模板;浏览器与读屏版本按项目实际填写。
## 已知障碍
| ID | 影响 | 环境 | 复现步骤 | 状态 |
| --- | --- | --- | --- | --- |
| A11Y-001 | 键盘无法关闭对话框 | Chrome(版本待核实)+ NVDA(版本待核实) | 打开示例页 → Tab 到“关闭” → 按 Enter | 已确认,未修复 |
| A11Y-002 | 图表缺少文字替代 | 所有环境 | 用读屏浏览“统计”页 | 待核实 |
## 支持环境
- 已验证:占位组合,按测试记录填写
- 未测试:Safari + VoiceOver
## 报告流程
- 渠道:仓库 Issues,标题前缀 `[a11y]`
- 响应:收到后 5 个工作日内确认(示例口径,按项目实际调整)
状态建议只用少数可判定值:已确认、待核实、计划中、已修复。日期用 ISO 格式,便于排序和比对。
三条容易越界的写法#
- “本项目建设完全无障碍”:无法证伪,也不等于任何标准。删掉,改成具体目标与已知障碍清单。
- “符合 WCAG”:必须补上版本、级别、评估范围和评估方式;没有记录时写成目标或待核实。
- 把路线图写成承诺日期:写“计划中”并链接对应 issue,比写一个无法保证的日期更可核查。
维护:让条目跟得上代码#
- 发布前更新“已知障碍”的状态,关闭 issue 时同步修改文件。
- 把更新责任写进贡献指南或发布清单,避免声明长期停在旧版本。
- 用一条简单标准自检:第三方能否在十分钟内复现或证伪这条记录?不能就继续拆细。
ACCESSIBILITY.md 不需要写得长,但每条都要能被别人验证。先固定五个区块,再把已知障碍拆成带编号、环境、步骤和状态的条目,这份声明才真正可用。
常见问题(FAQ)
ACCESSIBILITY.md 必须按固定模板写吗?
材料没有给出官方模板。可按目标、已知障碍、支持环境、贡献者期望、报告流程五个区块组织,再按项目规模增减,但每个区块都要留下可判定的信息。
可以写“本项目符合 WCAG 2.2 AA”吗?
只有在写明评估范围、评估方式和版本,并能提供对应记录时才写。否则应写成目标或待核实项,避免把声明变成无法验证的合规承诺。
GitHub 一定会识别我的 ACCESSIBILITY.md 吗?
据 GitHub 博客 2026 年 11 月 5 日的文章,GitHub 会突出显示该文件;但识别路径、文件名大小写、展示位置等细节,本次材料未提供,需以官方文档或实际仓库验证为准。
参考来源
以上为本文写作时的参考资料,引用观点以原文为准。