无障碍
通过良好的结构和有用的元数据,你可以让文档更具可访问性和包容性。
本页总结了 Google 免费课程面向无障碍的技术写作(CC BY 4.0)中的一些要点。
使用简洁的语言
大多数阅读 VRChat 创作文档的用户使用英语,但他们可能不理解复杂的词汇或短语。
- 避免使用陌生的术语、美国俚语、流行文化引用和复杂的语言结构。
- 遵循风格指南提高文档的清晰度。
创建有用的标题
Markdown 支持不同级别的标题。标题可以改善文档结构,帮助读者理解内容。
- 每个文档都应使用一级标题(
#)作为标题。 - 使用其他级别的标题(
##、###...)创建章节。 - 不要跳过标题级别(即从
##跳转到#####)。
包含信息丰富的链接文本
使用屏幕阅读器的人经常用它来扫描页面,只听取链接内容。使用信息丰富的链接文本,确保读者听到有意义的信息,而不仅仅是"了解更多、了解更多、了解更多"。
- 避免:Learn more、Click here、This page
- 更好:Learn more about our roadmap。
编写有用的替代文本
Markdown 允许你为图片提供替代文本。屏幕阅读器会为盲人或低视力读者朗读替代文本。
使用简短的短语或一到两句话。过长的描述会中断屏幕阅读器用户的阅读流程。
- 不要包含"Image of"或"Photo of"等多余词语。
- 首字母大写并加上句号。
- 根据需要添加其他标点符号。
例如:

http://creators.vrchat.com
