欢迎访问天云祥宁波服务外包      联系人:洪胜      服务热线:4008875538      电话:13530954096 (微信号)
天云祥宁波呼叫中心
洪胜 13530954096

宁波你应该在你的知识库风格指南中包括什么?(5个要素)

发布时间:2022-05-17 09:25:49 人气:1808 来源:天云祥客服外包

作者:丽贝卡·莱恩2021年10月31日

您的知识库风格指南中应该包括什么?(5)分享:我们在日常生活中使用风格指南。你可能没有注意到,因为这是沟通的自然组成部分。无论你在哪个行业工作,作家都会使用一套特定的书面规则。

想想看。你怎么读书?从左到右。一本书是如何组织的?分成几章。或者,当你写电子邮件或手写便条(是的,那些古老的东西)时,首先是什么?称呼和名字。

在社会上,我们遵循一定的书面规则。这些规则使我们很容易快速找到我们需要的信息。如果我们需要知道这封信是谁写的,我们会检查底部的签名。这些沟通规则简化了我们的生活。

作为一名前记者,我很高兴地订阅了《美联社风格指南》,我很欣赏清晰定义的沟通规则的力量。

现在,作为ScreenSteps(一家知识库软件公司)的内容营销经理,我明白了知识库风格指南对于向员工传达政策、流程和程序是多么重要。

在本文中,我将解释为什么您需要一个样式指南来编写更清晰的知识库文章。然后,我将在知识库样式指南中提供五个您想要标准化的元素。

为什么需要知识库风格指南?有一个风格指南,可以帮助您和您的团队创建外观一致的学习材料。

如果您的风格指南不一致,那么您的员工需要学习如何在每次打开由不同内容作者编写的策略或过程时阅读新指南。

考虑:当员工A编写过程时,指南看起来是单向的。当员工B编写程序时,指南看起来是另一种方式。然后,员工C对如何阅读和遵循说明感到困惑,因为这取决于员工A还是B编写的指南。知识库风格指南的目的知识库风格指南有多个目标。最重要的是,它要创建的程序和学习材料是:

简洁、清晰、易于通过搜索找到、视觉上合理、易于遵循的。风格指南对内容作者和读者都有帮助。

这对作者来说很重要,因为它可以引导他们创建的学习材料和程序,有效地帮助员工执行和学习。

这对读者来说很重要,因为他们每次阅读一个过程时都能获得一致的体验,并且他们可以在更短的时间内采用新的过程和更新旧的过程。知识库风格指南中要概述的

5个元素您应该在知识库风格指南中包含哪些信息?你需要包括如何处理写作和展示文章不同方面的信息。这里有一些需要考虑的元素,包括:

1。程序标题您使用什么格式保存程序?您希望您的员工能够快速、轻松地找到您的程序。

更佳实践

当你写一篇文章时,很容易用技术术语创建一个标题。相反,您希望使用对员工或客户来说是自然的术语。

回答一个特定的问题。包括标题开头的“如何……”。然后将个单词和专有名词大写。例如,

,而不是标题为“采购订单”,标题为“如何更新采购订单”或“如何处理采购订单”

2。

一文的副本您的程序的书面部分是什么样的?你的文章应该多长时间?写作指南有很多要素需要考虑。在小学,我们学习语法的力量。逗号可以改变句子的意思,比如有很多工具可以帮助您在不过度拥挤的情况下提供更多信息,其中包括:

表表是在较小的空间内共享大量信息的好方法。表格通常用于根据不同变量有选项的情况。

提示框使用提示框突出重要信息。基本上,小费盒会突出显示“不要想我”的信息。它可以让信息在页面上弹出,这样浏览文章的人就不会错过它。

可折叠部分使用可折叠部分提供相关但非必需的附加信息。

例如,您的大多数员工可能都知道如何交换internet路由器。但是,如果客户想升级他们的路由器,而不是仅仅更换路由器,一些员工就会陷入困境。这些员工可以点击一个可折叠的部分展开,以获得更详细的说明。

但您将如何以及何时在公司中使用它们?你会在一个可折叠的部分包含多少信息?什么时候需要创建一个单独的过程(又名:折叠部分的信息太多)?

链接决定何时可以添加链接。哪些情况需要链接到知识库中的另一篇文章?你的内容作者链接到哪些网站?

提示:您可以创建特定于操作和过程的文章。并撰写专门解释背景和概念的文章。你可以在这两种类型之间建立超链接,这样你就不会用不必要的(尽管有用的)信息压倒你的员工。

您应该先写哪些知识库文章?是一个知识库风格指南,使内容作者和读者更容易交流。当使用风格指南撰写文章时,员工知道应该期待什么,并且可以轻松地遵循指南。

创建知识库样式指南之后,是时候开始编写策略和过程了。

通过屏幕步骤,您可以在我们的知识库中编写并分享您的知识库风格指南。此外,您还可以保存文章模板,以便更快地编写内容。通过在屏幕步骤中清晰地编写程序,公司提高了生产率。

很难决定要编写哪些过程?下载这张头脑风暴工作表,找出首先要为你的知识库写哪些文章。

关于Rebecca Lane

内容营销经理

与Rebecca Lan连接

最近更新

客户服务
live chat
点击这里给我发消息