如何编写包容性文档

笔锋胜于剑芒。这句谚语强调了文字的力量。写作是传递有力思想的重要工具，更重要的是，它能用你的观点影响读者。因此，内容创作者肩负着明智使用这一工具的重大责任。内容创作者不应表现出任何偏见，并应以友好的语气创作内容，以吸引任何阅读者。包容性是关键！

包容性文档必须公平、平等地对待许多不同类型的人。无论其性别、种族、宗教、所在地等如何，每个人都应受到有尊严和尊重的对待。在文档风格中表现出同理心，是解锁对所有用户公平和平等潜力的关键。包容性文档能促进社会和谐，让我们的星球成为更美好的家园。保持包容性应成为文档框架的指导原则，内容创作者需要实践创作无偏见的包容性内容。

由于内容创作者不了解其受众的特征，他们必须选择合适的语言、语气，更重要的是，用词来表达他们的想法。内容创作者选择的措辞至关重要！使用性别中立的人称代词可以增强对女性和LGBTIQ人群的积极情感。表达思想和观点的词语不应歧视或冒犯世界上的任何人。

 性别中立术语有助于避免偏向某一性别。在内容中避免使用特定性别的代词有助于实现性别中立。例如，不使用“门外汉”、“工时”、“人类”等术语，而是选择“普通人”、“人工时”、“人类”这样的术语。不使用“黑名单”和“白名单”这类词汇，而是使用“阻止列表”和“允许列表”。这有助于消除文档中的文化偏见。除了内容撰写，UX文案撰写者也应更多关注菜单项、对话框中的版权文本以及弹窗文本，确保在整个产品中使用性别中立的术语。避免使用“主从架构”这类术语，而是使用“两层架构”。需要检查代码片段、API请求体和响应示例，以确保使用性别中立的代码段。

 选择合适的语气是内容撰写者需要练习和精通的技能。语气和语言本身一样，其作用在于人们对词汇背后的含义有共识。文化规范常常决定了人们对这些词汇的感知方式。能够传达预期的情感需要了解这些规范和期望，以及对话的语境。其重要性通常与信息的重要性相匹配，因此需要更多的关注。使用中立的语气撰写有助于不对内容引发任何积极或消极的感受。以下是一些建议：

应避免使用当地语言和语境中的俚语。某些用于指代事物的本地俚语，在您全球受众所在的其他国家/地区可能具有冒犯性或显得滑稽。内容创作者不应为追求趣味和诙谐而使用俚语叙述内容。

全球许多国家都针对文化适宜的语言提供了特定指南。必须始终如一地使用尊重性语言和词汇来指代与年龄相关的内容。在任何语境中都应避免使用性别特定的头衔和职位角色。

如果您在内容中使用了包含人物头像和姓名的视觉素材，采用多样化的头像和姓名能支持您的包容性原则。呈现多元人群的视觉元素能促进文化多样性，并展示包容的企业文化。这将提升品牌形象和客户忠诚度。品牌形象通常与其所代表的价值观紧密相连。在任何社会危机期间，品牌方往往会为其包容性和多样性立场发声，从而增强品牌意识。

在制作营销和教程视频时，融合不同角色和声音能促进公平与平等。包容性和多样性与公平、平等理念密切相关。

5. 讨论无障碍和残疾时使用正确的术语

残疾并不能定义一个人。内容作者在撰写关于残疾人或无障碍内容时，应避免偏见和伤害。内容作者需要研究和遵循无障碍指南中推荐的术语，并理解词语的细微差别。应避免使用本质上是评判性的词语，以免伤害人们的感情。内容中不应出现带有委婉语或居高临下意味的术语，因为这可能造成伤害。

良好的产品文档风格指南、词汇表术语以及其他供技术内容作者遵循的指导方针需要被制定和遵守。需要定期对内容作者进行包容性和多样性准则的培训。这种培训可以作为公司内部人力资源实践的一部分，分别用于新内容作者的入职培训和现有内容作者的技能提升。

应每年进行一次内容审计，以确保现有内容符合包容性和多样性原则。审计应识别任何文档差距，并提供改进内容质量的建议。这些审计报告可以公开，以赢得客户对Baklib坚持包容性和多样性原则的信任。

延伸阅读： 什么是软件文档？其类型与最佳实践

撰写包容性的文档有助于创造社会凝聚力，并促进全球受众间的和谐。包容性语言应成为技术内容撰写者技能的一部分。技术内容撰写者应定期接受包容性文档实践培训。这将使创作出的内容更能吸引全球受众，并与公司的价值观保持一致。

延伸阅读： 内部文档：如何创建、技巧与示例

Baklib数字内容体验云是一个综合性的云平台，旨在通过云原生的形式为企业提供中台式全栈数字内容的管理。它结合了媒体资源管理、知识库、网站管理、知识社区、数据分析和AI就绪等技术，以支持创建、管理、发布和优化数字内容。Baklib专注对数字内容的最大化利用，帮助企业在各种数字渠道上提供一致性、相关性且吸引人的数字体验。