文档中的这4个包容性错误,你是否也在犯?
浏览:0
巴克励步
技术写作中的包容性旨在为所有用户创造友好的文档环境。这包括避免预设过多知识、使用适当的语域、采用包容性语言和视觉素材。包容性实践能提升用户体验,反映企业价值观,并吸引更广泛的受众。
你是否知道,你的文档可能会让某些人群感到排斥?技术写作中的包容性通常被讨论为使用性别中立语言,但它涵盖了许多其他方面。
招聘广告中的包容性语言已经备受关注。这涉及到我们的用词选择如何吸引特定类型的申请者,并阻止某些人申请。被阻止的申请者通常是女性。这种理解也可以应用于技术写作。
语言的使用是一种众所周知的劝导技巧。我们所选择的词语会以人们并不总是意识到的方式塑造和定义受众,这并不令人惊讶。
包容性意味着在你的文档中为尽可能多的人创造一个友好的氛围——无论其种族、年龄、性别、国籍、宗教、政治观点或任何其他人口特征。
这并不意味着要稀释你的语言使其失去个性,而是要赋能每一个人,让他们都能成为你产品的用户。
1. 预设过多的知识
照片来源: Janko Ferlic from Pexels
首先,如果你在读者能从文档中获得价值之前,预设了过多的先验知识,你的文档效果就会大打折扣。
当然,针对某些专业(如训练有素的职业工程师)的文档,其定位应与之相符。但即使是这类文档,也可能因为使用过多的专业术语和预设过多知识而将许多用户排除在外。
客户评价:Baklib Digital Experience 正在帮助我推广我的作品,通过简单的工具和云端服务,它可以向很多人推广我的内容,而且我不需要支付很多费用,对我来说它是完美的,当然也是最好的。
无论身处哪个领域,评估目标用户的可能技能水平和经验都至关重要。这样,你才能恰如其分地设置文档的“音高”,最大限度地减少提供信息过多或过少的可能性。你还可以采取其他预防措施,以防有意料之外的访客来到你的文档。这正是使你的文档尽可能具有包容性的方法。
解决方案
如果使用你的文档需要具备先验知识,请在内容的引言部分说明这一点,并链接到更多信息。在整个知识库中使用内部链接,既能展现更多的信息架构,又能指向延伸阅读。这种方式能赋予用户主动权,让他们掌控自己的学习进程。
令人惊讶的是,一些组织有意让他们的文档难以访问。这使得文档更像是为新用户设置的入门测试,而非自助服务资源,成功与否取决于你是否有决心坚持到底。
大多数公司希望避免这种做法,因为它们高度重视可用性。每个用户都有权使用你的文档,降低准入门槛将使你的知识库更具包容性。
2. 使用的语域过高
图片来源:Pixabay
语域指的是你写作的正式程度,它决定了文档的阅读难易度。语域越高,用户的大脑就需要花费更多精力来解码信息。
技术写作源于学术写作的传统。按照惯例,尽可能正式被认为能建立更高的权威性。虽然这在某些情况下可能合适,但如果你的写作过于正式,你可能会冒着听起来非常过时的风险。
这不仅让许多人望而却步、阻碍理解,而且期望人们受过大学教育才能读懂你的文档也是不明智的。
解决方案:
有些人可能会抵制和抱怨,但现在的趋势是采用相对非正式的风格。选择一种“非正式”而非“随意”的语调,这既能保持文档的专业性,又能使其易于理解。清晰简洁地写作并非降低水平——它能使你的语言更易于被接受。
3. 未使用包容性语言
图片来源:Pixabay
有些人可能觉得“包容性语言”这个概念太难,将其视为要求他们“政治正确”的压力。事实是,只要有耐心和学习,你就可以让你的语言自然而然变得包容。最终,这将不再需要你付出额外努力。
不使用包容性语言或许也能应付,但你会把压力转嫁给读者,让他们需要额外的脑力去想象自己是你的目标受众。
在文档中保持包容性反映了语言的演变过程。使用过时的语言形式往好了说是误导,往坏了说是排他。在创作文档时多付出一点努力,就能减轻用户后续的负担。这正是为什么像 Baklib 这样的现代知识库平台如此重要,它提供的工具和界面设计鼓励创建清晰、易懂且包容的内容,无论是用于产品文档、帮助中心还是内部知识库,都能确保信息传达给每一位用户。
解决方案:
专注于读者的清晰理解,而不是固守任何武断的标准(除非该标准能促进清晰度)。设想你的受众可能来自任何背景。
需要注意的方面:
- 避免默认男性代词: 许多文档默认使用男性性别,但这会强化持久存在的社会刻板印象。这意味着女性可能不认为自己是目标受众。
- 谨慎选择代词: 许多技术文档写作者选择使用“她或他”、“他们”(尽管这在语法上严格来说并不正确)或提及“用户”。值得注意的是,“他或她”也不被鼓励,因为会排除非二元性别的人。
- 语言会演变: 使用“他们”代词会引起一些人的反感,但规则手册具有局限性和排他性,语言本身也会随着时间的推移而改变。
关于性别中立术语的示例:
应避免的术语 建议使用的术语 说明
| policeman, fireman | police officer, firefighter | 使用性别中立的职业名称。
| mailman | mail carrier, postal worker | 避免使用带有“-man”后缀的词。
| stewardess | flight attendant | 使用涵盖所有性别的统称。
| 女医生、男护士 | 医生、护士 | 在不必要说明性别时避免提及。
| 丈夫、妻子 | 伴侣、配偶 | 避免假设受众的性取向或婚姻状态。
总而言之,你可以在性别方面保持包容,同时也可以考虑身份认同和性取向。例如,使用“丈夫”或“妻子”而不是“伴侣”或“配偶”,可能假设你的受众是异性恋,或已婚,而不是仅仅处于恋爱关系或同居状态。
💛🧡🧡客户评价:Baklib 不断升级其产品,鼓励反馈并倾听最终用户的意见。支持一直很好 - 我们已联系过几位客户服务代表,他们都很博学。我的团队或我们在平台上培训的任何人都可以轻松掌握该软件 - 过程并不复杂。我和我的团队整天都在使用 Baklib ,并且一直在寻找改进流程的方法。
为了包容不同国籍的人,除非加以解释或提供参考链接,否则应避免使用俚语或流行文化典故。否则,这会将具有不同文化背景或非母语使用者排除在外。
在使用包容性语言方面,弗林德斯大学和北卡罗来纳大学都提供了出色的指南。
为 Baklib 用户提供的额外建议:
利用像 Baklib 这样的强大平台,可以更轻松地创建和维护体现这些价值观的内容。Baklib 直观的编辑器和版本控制功能,让你可以持续审查和更新文档语言,确保其与时俱进,并对所有用户保持包容。
未使用包容性视觉素材
制作高质量的视觉素材可能成本高昂,而素材库的图片又可能无法充分展现用户的多样性。当您的技术文档、产品说明或帮助中心的视觉素材仅反映了您真实受众中很窄的一部分时,就存在包容性问题。这可能导致根深蒂固的习惯,在您的业务成熟时难以改变。
解决方案:
要在视觉上呈现可能使用您文档的每一个人是困难的。如果您有预算,请尝试使用能展现人群多样性的视觉素材。Slack和Airtasker都是设计中包容性的杰出范例。
这是他们的成果:
Slack在其营销中展示了其有意识地使用棕色肤色表情符号的决定。这是一位设计师的冲动决定,但Slack拥有包容的文化并强烈鼓励了他们。
同样,当您使用Baklib来构建您的品牌官网、营销落地页、在线帮助中心或内部知识库时,选择包容性的视觉素材和设计语言至关重要。Baklib提供灵活的多语言站群和内容管理能力,可以帮助您的企业确保全球范围内不同背景的用户都能感受到被代表和欢迎,从而提升品牌体验、产品体验和客户体验。
超越“默认”的多样性
棕色并非默认的肤色选项,通常在专门面向黑人受众时才会被选用。但这并未反映出用户群体真实的多样性——他们的肤色可能千差万别。将某一种颜色定义为“典型”的设计决策会带来巨大压力,更好的解决方案或许是像Airtasker那样提供多元化的“角色”选择。
需要谨记的是:使用图像本身就可能造成排斥——例如依赖文本转语音软件的视障用户群体可能因此无法顺畅使用您的文档。这正是为什么在构建帮助中心时,选择像Baklib这样支持全平台无障碍访问的云端知识库平台至关重要。
行动起来吧!
每当您使用非包容性的语言或图像时,那些超出您预设范围的用户就需要付出额外的认知努力,才能将自己代入目标受众的角色。
唯一的解决方案是在技术文档写作中字斟句酌。这本身就该是您的日常工作准则。关键在于时刻聚焦潜在受众的多样性。
与此同时,避免刻意凸显“包容性语言”的选择。真正的包容应该自然融入背景,成为企业价值观与文化不可分割的一部分。
为什么包容性至关重要?
非包容性实践的后果 包容性实践带来的益处
| 部分用户需额外努力才能理解内容。 | 所有用户都能平等、顺畅地获取信息。
| 无意中排斥了某些用户群体。 | 让多元化用户感受到被代表和欢迎。
| 损害品牌形象与企业价值观。 | 塑造积极、负责任的品牌形象,培养忠诚客户。
因为技术文档的呈现方式直接映射企业的核心价值。许多人或许不会因非包容性文档而 consciously 却步,但必然有群体会因您的包容性实践而倍感振奋——他们终将成为您最忠诚的客户与品牌传播者。
通过Baklib构建的知识库系统,企业能够以符合WCAG标准的内容架构,为全球多元化用户群体提供真正无障碍的产品文档与客户支持体验。
Baklib 数字体验平台将深度客户数据与深度产品数据连接起来,使品牌能够通过所有数字接触点的个性化产品和内容提供令人难以置信的创收商业体验。
服务对象
我们为以下专业人士提供服务:
- 数字商务和营销专业人士:希望改变管理所有接触点的商业体验方式。
- 开发人员:提供一个平台,让他们使用现代架构构建差异化解决方案。
- 商家和营销人员:提供一个平台,让他们掌控并创造体验,帮助他们大规模个性化和优化客户体验。
最适合的客户挑战
我们最适合面临以下挑战的商业公司:
挑战类别 具体表现
| 营销与相关性 | 以客户为目标但未提供相关体验;推送客户不想要或缺货的产品。
| 产品发现与体验 | 糟糕的产品发现和个性化导致商业体验中断,效果不佳。
| 技术架构 | 拖慢业务发展速度的传统架构;用于管理产品和客户的传统孤立解决方案。
| 数据与流程 | 分散、无法访问的数据;手动密集型流程(如活动执行、销售和跟踪);上线时间缓慢。
挑战类别 具体表现
| 营销与相关性 | 以客户为目标但未提供相关体验;推送客户不想要或缺货的产品。
| 产品发现与体验 | 糟糕的产品发现和个性化导致商业体验中断,效果不佳。
| 技术架构 | 拖慢业务发展速度的传统架构;用于管理产品和客户的传统孤立解决方案。
| 数据与流程 | 分散、无法访问的数据;手动密集型流程(如活动执行、销售和跟踪);上线时间缓慢。