7.2 文化敏感内容
本节规范了技术文档中涉及文化差异内容的处理方式。
R-133
必须
日期和时间格式需明确标注
技术文档中出现的日期和时间必须使用明确的格式,避免产生歧义。不同地区的日期格式差异较大,例如「01/02/2025」在不同地区可能被理解为 1 月 2 日或 2 月 1 日。建议使用 ISO 8601 格式(YYYY-MM-DD)或用文字明确标注。
各地区日期格式对照
| 地区 | 格式 | 示例 |
|---|---|---|
| 中国 | YYYY 年 MM 月 DD 日 | 2025 年 3 月 15 日 |
| 美国 | MM/DD/YYYY | 03/15/2025 |
| 欧洲 | DD/MM/YYYY 或 DD.MM.YYYY | 15/03/2025 |
| ISO 8601(推荐) | YYYY-MM-DD | 2025-03-15 |
R-134
推荐
避免带有文化偏见的假设
技术文档中应避免做出基于特定文化背景的假设。包括但不限于:不要假设所有用户都使用从左到右的文字方向;不要假设特定颜色在所有文化中含义相同(如红色在中国代表喜庆,在某些文化中代表警告);不要在示例中仅使用某一种文化背景的人名或地名。
正确
用户注册示例: 姓名:张伟 / John Smith / Tanaka Yuki 日期格式:2025-03-15(ISO 8601)
错误
用户注册示例: 姓名:John Smith 日期格式:03/15/2025
正确示例使用了多元化的姓名示例和国际标准日期格式。错误示例仅使用英文名,且日期格式对非美国用户可能产生歧义。
提示
关于姓名顺序差异:中文、日文、韩文等东亚语言的姓名顺序通常是「姓在前,名在后」,而英文等西方语言通常是「名在前,姓在后」。在设计用户界面或编写文档时,应注意这一差异,建议分别设置「姓」和「名」字段,而不是使用单一的「姓名」字段。在文档示例中,应说明所使用的姓名顺序规则。