6.3 替代文本
本节规范了技术文档中图片替代文本(alt text)的编写要求,以满足无障碍访问标准。
R-120
必须
所有图片必须提供替代文本
技术文档中的所有图片元素都必须提供替代文本(alt text)。这是无障碍访问(Accessibility)的基本要求。替代文本使视觉障碍用户能够通过屏幕阅读器理解图片传达的信息。缺少替代文本的图片不符合 WCAG 2.1 AA 级合规要求。
R-121
推荐
替代文本应描述图片传达的信息
替代文本应描述图片所传达的关键信息,而非图片本身的外观。例如,对于一张显示错误提示的截图,替代文本应描述错误信息的内容,而不是「一个弹窗的截图」。替代文本长度建议不超过 125 个字符,如需更详细的描述,应使用长描述(longdesc)或在正文中补充说明。
替代文本写法对比
| 图片类型 | 好的替代文本 | 差的替代文本 |
|---|---|---|
| 截图 | 系统设置页面,「网络」选项卡处于选中状态 | 截图 |
| 图表 | 2024 年各季度用户增长趋势折线图,Q4 达到峰值 50 万 | 图表 |
| 装饰图 | (使用空的 alt 属性:alt="") | 蓝色横幅图片 |
| 图标 | 保存(用于描述保存功能的磁盘图标) | 图标 |
DITA 图片替代文本示例
<!-- 功能截图:提供描述性替代文本 -->
<fig id="fig_network_settings">
<title>图 5-1 网络设置界面</title>
<image href="images/network_settings.png"
placement="break"
width="600px">
<alt>系统设置页面,左侧导航栏的「网络」选项
处于选中状态,右侧显示代理服务器配置区域</alt>
</image>
</fig>
<!-- 装饰图:使用空替代文本 -->
<image href="images/divider.png"
placement="break">
<alt/>
</image>