如何编写包容性文档?我推荐这个在线编辑文档工具——Baklib

笔比剑更强大。这句谚语强调了文字的力量。写作是传达强大思想的有力工具,最重要的是用你的想法影响你的读者。因此,内容作者有责任明智地使用此工具。内容作者不应表现出任何偏见,并以友好的语气制作内容,以吸引任何阅读其内容的人。包容是关键!

包容性文档必须公平和平等地对待许多不同类型的人。每个人都受到尊严和尊重,无论其性别、种族、宗教、地点等如何。在你的文档风格中表现出同理心可以释放公平和平等的潜力。包容性文件促进了社会和谐,使我们的星球成为一个更美好的居住地。包容性应该是文档框架的指导原则,内容作者在制作无偏见的包容性内容时需要实践。

由于内容作者不知道受众的特征,因此他们必须选择正确的语言、语气,更重要的是用词来表达他们的想法。内容作者选择的单词的选择很重要!使用性别中立的代词可以增强对妇女和LGBTIQ人群的积极感受。思想的言语和表达不应歧视或冒犯世界上的任何人。

一个直观的知识库软件,可轻松添加您的内容并将其与任何应用程序集成。试试 Baklib!

编写包容性文档的五个步骤

  • 1. 使用性别中立的术语

性别中立的术语有助于避免偏袒性别而不是其他人。避免在内容中使用性别特定的代词有助于实现性别中立。例如,不要使用外行、工时、人类等术语;选择外行、工时和人类等术语。

不要使用黑名单和白名单等术语,而应使用阻止和允许等术语。这消除了文档中的文化偏见。除了内容写作之外,UX撰稿人还应更加关注菜单项,对话框中的版权文本和弹出文本,以确保在整个产品中使用性别中立的术语。

避免使用从主架构等术语;请改用双层体系结构等术语。需要检查代码片段、API 请求正文和响应示例,以遵守使用中性代码段。

  • 2. 选择中性和友好的语气

选择正确的语气是内容作者需要练习和擅长的技能。语气和语言本身一样,之所以有效,是因为人们同意单词背后的含义。文化规范往往决定了人们如何看待这些。需要了解这些规范和期望,以及对话的背景,才能传达预期的情感。为了匹配信息的重要性,风险通常会升高,因此需要更多关注。以中性的语气写作有助于不引起对内容的任何积极或消极的感觉。一些建议是

使用正确的标点符号

如果您希望屏蔽任何相关的时间,请使用动名词而不是动作词,确保信息以正确的速度在内容中流动,在发布前校对您的内容。

  • 3. 避免使用俚语

应避免使用当地语言和上下文中的俚语。一些用于指代事物的当地俚语在您的全球受众来自的其他国家/地区可能令人反感或有趣。内容作者不应使用俚语来叙述任何事情,以使内容变得有趣和诙谐。

世界上许多国家/地区都提供了针对特定国家/地区的文化语言指南。必须以一致的方式使用尊重的语言和词语来指代与年龄相关的内容。避免在任何情况下使用特定于性别的头衔和工作角色

  • 4. 使用性质多样化的视觉效果

如果在具有个人资料图片和名称的内容中使用任何视觉对象,则具有不同的个人资料图片和名称可以支持你的包容性原则。人与人混合的视觉效果促进了文化多样性并展示了包容性的企业文化。这提高了品牌形象和客户忠诚度。品牌形象通常与其所代表的价值观相关联。在任何社会危机中,品牌都会坚持其包容性和多样性,从而扩散品牌意识。

在营销和教程视频制作过程中,不同角色和声音的良好组合可以促进公平和平等。包容性和多样性与公平和平等密切相关。

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

残疾并不能定义人。内容作者在撰写有关残疾人或无障碍的文章时应避免偏见和伤害。内容作者需要研究和首选术语的可访问性指南,并了解单词的细微差别。应避免使用具有判断性的术语,以免伤害人们的感情。表现出委婉语或居高临下的术语不得出现在内容中,因为它可能会造成伤害。

培训和内容审核

良好的产品文档样式指南、词汇表术语以及技术内容编写者应遵守的其他指南。内容作者需要定期接受包容性和多样性指南的培训。这种培训可以成为公司内部人力资源实践的一部分,分别让新的内容作家入职和提高当前内容作家的技能。

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

Baklib专业的制作工具

好的工具使文档制作变得事半功倍,解决了传统文档制作中更新维护成本高,与产品更新不同步,长期易产生滞后等问题。Baklib是一款专业的帮助中心与知识库知足工具,帮助企业轻松制作在线的帮助中心、Guide、FAQ、API文档、产品手册...实现企业向内知识协同和对外品牌宣传。十分钟就可为企业打造专属的帮助中心页面,所见即所得,随时编辑随时发布,清晰的解释您的产品,更好的服务于您的用户。

一个帮助页面,多个应用场景

Baklib是一款在线应用,直接网页在线使用,不需要编程和设计基础,三个步骤轻松制作出一个帮助页面,轻松编辑文档,随时编辑、随时更新、随时发布,让客户点点鼠标就可轻松查看。

一、小程序的帮助中心

提供不同的主题,每个主题制作出来的页面效果不同,根据产品调性进行调整,形成统一风格,并且多端适配,支持电脑端和手机端展示,可以直接将页面嵌入官网或者APP中,用户点击即可访问。

二、官网的帮助中心

三、移动端的帮助中心

四、内部权限的帮助中心

Baklib特点功能:

  1. 支持富文本和Markdown编辑,可以将图片、视频、文件等上传到文章中,直接在文章内部编辑保存,在帮助中心就能展现,随时可以更改调整内容;
  2. 网页剪藏,可以直接将网页内容一键提取保存到站点内部,提高工作效率;
  3. 全文检索,搜索类似百度,关键词高亮显示,给用户良好的搜索体验,在问题下方还有文章反馈按钮,可以查看该回答是否解决了用户的问题;
  4. 多端适配,支持手机端和电脑端显示,不仅能链接到官网,还能放在APP、公众号等地方。
  5. 外部展示上:Baklib提供了多种对外的展示主题,手机端适配,可以随意切换变更颜色,支持页脚的添加,独立域名的绑定......
  6. 细节:提供了很多实用插件包括全局搜索、用户反馈功能、文章导读、帮助站点的访问统计、站点导航.....

结论

撰写包容性文件可以创造社会凝聚力,并有助于在全球受众中传播和平。包容性语言应该是技术内容作者技能的一部分。技术内容编写者应定期接受有关包容性文档实践的培训。这导致内容创作能够吸引全球受众并符合公司的价值观。

举报
评论 0