9.1 无障碍写作原则
无障碍写作旨在消除信息获取的障碍,使所有用户(包括残障用户)都能有效使用技术文档。
为什么技术文档需要考虑可访问性
可访问性(Accessibility)是指产品、设备、服务或环境对所有人(包括残障人士)的可用程度。技术文档作为产品的重要组成部分,同样需要遵循可访问性标准。
技术文档关注可访问性的原因包括:
- 法律合规:许多国家和地区已将数字内容的可访问性纳入法律要求,如欧盟的《欧洲无障碍法案》和中国的《信息技术 互联网内容无障碍可访问性技术要求与测试方法》(GB/T 37668-2019)
- WCAG 合规:Web 内容无障碍指南(WCAG)2.1 是国际公认的无障碍标准,技术文档应至少达到 AA 级合规
- 包容性设计:良好的可访问性设计不仅惠及残障用户,也能提升所有用户的使用体验,例如清晰的层级结构和描述性链接对所有读者都有帮助
- 商业价值:全球约 15% 的人口有某种形式的残障,忽视可访问性意味着排除大量潜在用户
R-150
必须
使用清晰的文档层级结构
技术文档必须正确使用标题层级(H1 至 H4),且不得跳级。例如,H2 之后不能直接使用 H4,必须先使用 H3。清晰的层级结构不仅有助于视觉浏览,更是屏幕阅读器用户导航文档的主要方式。每个页面应只有一个 H1 标题。
R-151
推荐
链接文本必须描述链接目标
超链接的显示文本应清晰描述链接目标的内容,使读者无需依赖上下文即可理解链接的用途。避免使用「点击这里」「单击此处」「更多」等无意义的链接文本。屏幕阅读器用户经常通过遍历页面中的链接列表来导航,描述性链接文本对他们尤其重要。
正确
详细配置方法请参阅《数据库连接配置指南》。
错误
详细配置方法请点击这里。
正确示例的链接文本「数据库连接配置指南」清晰描述了链接目标,用户一眼就能判断是否需要跳转。错误示例中的「点击这里」没有任何描述性信息,屏幕阅读器用户在遍历链接列表时只会听到「点击这里」,无法判断链接指向何处。
WCAG 2.1 对技术文档的要求有哪些?
WCAG 2.1 基于四个核心原则(POUR),对技术文档的主要要求包括:
- 可感知(Perceivable):为非文本内容提供替代文本;确保内容在不依赖颜色的情况下可以理解;文本对比度达标
- 可操作(Operable):所有功能可通过键盘操作;为用户提供足够的操作时间;不使用可能引发癫痫的闪烁内容
- 可理解(Understandable):文本内容可读且可理解;页面操作方式可预测;提供输入辅助和错误提示
- 健壮性(Robust):内容兼容当前和未来的辅助技术;使用标准化的 HTML 语义标记
如何检测文档的可访问性?
检测文档可访问性可以采用以下方法:
- 自动化工具:使用 axe、WAVE、Lighthouse 等工具扫描网页文档,自动检测常见的可访问性问题
- 手动测试:使用键盘导航测试所有交互功能;使用屏幕阅读器(如 NVDA、VoiceOver)体验文档
- 对比度检查:使用 Colour Contrast Analyser 等工具检查文本和背景的对比度是否达标
- 用户测试:邀请残障用户参与文档的可用性测试,获取真实的使用反馈
常见的可访问性问题清单
技术文档中常见的可访问性问题包括:
- 图片缺少替代文本(alt text)
- 标题层级混乱或跳级
- 链接文本无描述性(如「点击这里」)
- 仅依赖颜色传达信息(如红色表示错误)
- 表格缺少表头和标题
- 文本对比度不足
- PDF 文档未标记结构标签
- 视频内容缺少字幕
- 表单控件缺少标签
- 页面缺少跳转导航链接