组织起来！ 如何创建知识库样式指南

已发表: 2017-05-03

编写知识库已经够难的了。 所以我为我在这篇文章中要做的事情道歉。 我要告诉你，这不仅仅是关于你知识库中的想法，还与你如何呈现它们有关。

看，除了这些想法之外，您还需要确保您始终：

  • 使用适当的语气
  • 始终如一地格式化所有内容

出于我将在下一节中说明的原因，这实际上是非常困难的。 这就是知识库风格指南发挥作用的地方。

为什么你的知识库可能是不同风格的混乱

如果您的知识库是不同风格的混杂，请不要太担心。 它发生在很多公司身上，通常是出于两个原因之一（或者有时两者兼而有之！）。

首先，如果您是团队的一员，您可能会有不同的人编写支持文档。 因此，如果：

  • 吉姆写文章 A
  • 莎莉写文章 B

这些文章可能会有截然不同的风格和格式……除非你有一个预定义的风格指南。

现在，如果你不是团队的一员，你可能会说， “我是一只独狼——我自己写所有东西。 所以我不需要把任何东西写在纸上——全是我！”

情况可能就是这样……如果您一口气写完所有知识库文章。

但我们都知道事情通常不是这样运作的，对吧？ 当您第一次发布产品时，您可能写了一堆知识库文章。

但是，三个月后，您发布了一项新功能。 现在您必须为该新功能编写知识库条目，而且……人类的记忆并不是那么好。 很有可能你最终会做一些不同的事情，即使你没有尝试这样做。

因此，无论您是独自一人还是团队成员，将您的知识库风格指南写在纸上都是值得的。

公司真的这样做吗？ 知识库风格指南是真实的吗？

好的，我马上会告诉你如何创建你的风格指南。 但首先，我想以一些实际这样做的公司为例。 这实现了两个目标：

  • 它向你展示了我不只是为了创造更多的博客内容而编造东西
  • 它为您提供了一个真实的示例，您可以从中提取自己的风格指南。

让我们先看看Mozilla。 Mozilla 在其知识库的样式指南中有完整的条目。 因为 Mozilla 是开源的，所以他们有一个风格指南尤其重要，用他们自己的话来说，“使 Firefox 支持知识库保持一致，从而形成一个易于阅读和贡献的知识库。”。 易于阅读？ 对于您的知识库来说，这听起来是一个不错的目标，对吧？

知识库风格指南示例 Mozilla

该指南深入浅出，带您了解从大写、空格到连续逗号的所有内容。

接下来，MailChimp 的 Voice & Tone 是另一个值得一读的内容。 虽然它不是 100% 专注于知识库，但它确实有许多用于知识库和教程内容的条目：

知识库风格指南示例 MailChimp

Mozilla 的风格指南更关注风格和格式，而 MailChimp 选择更多地关注语音和语气，而不是细节格式。

如何为您的知识库创建样式指南

我向你扔了几个例子，但我还没有给你一个实际创建你自己的知识库风格指南的过程。 所以让我们解决这个问题！

使用一致的人

你有没有读过作者在“我”和“我们”之间来回切换的文章？ 我有，我们可以告诉你，这非常令人困惑。

所以，如果你要使用第一人称——选择一个并保持一致。 即使你是独奏，你仍然可以选择使用“我们”。 由你决定！ 只需使用相同的。

此外，您甚至不需要使用第一人称。 您可以选择完全避开“我”和“我们”。

这里没有真正正确的答案——它只是关于一致性。

标准化您的格式

如果您阅读了我们的终极知识库文章模板指南，您就会知道好的知识库使用大量的小步骤说明。 在某些时候，这些说明将包括如下语言：

点击文件。

那么——是吗：

  • 点击文件
  • 点击“文件”
  • 点击文件

当您实际编写列表时，是不是：

  • 第一步：点击这个
  • 第2步：点击那个

或者是这样的：

  • 点击这里
  • 点击那个

再一次——你可以选择你最喜欢的一个——但无论你选择哪一个，都要在你的整个知识库中一致地使用它。

您还需要做出其他格式选择 - Mozilla 样式指南让您对要涵盖的所有内容都有一个很好的了解，但这里有一些入门想法：

  • 标题大写——你会使用句子大小写还是标题大小写？
  • 数字——是 10 还是 10？
  • 缩写词——不要还是不要？
  • 首字母缩略词——CDN 还是内容交付网络？

如果您使用我们的知识库 WordPress 主题或插件之一，我们的内置短代码和格式化选项可以帮助您在格式化时保持一致

获得正确的声音

最后，您需要超越格式并标准化您的声音。

你是你客户的朋友吗？ 或者你是星际迷航中的史波克，冷静地散发着冷酷的智慧？

在合理范围内，两者都可以。 只要是一致的。

一般来说，您应该确保遵循 MailChimp 的知识库指南提示。 我建议他们不仅是因为 MailChimp 实际发布了他们的指南，还因为我认为 MailChimp 拥有最好的知识库之一。

他们的建议是这样的：

  • 始终将回答问题和告知读者放在首位。 笑话有时是可以的，但如果它们分散了那个基本目标，那就不行了。
  • 避免像营销人员一样说话——你只是想提供帮助。

在哪里存储您的风格指南？

你不应该只是做出这些决定。 实际上，您还需要将它们写在安全的地方。

就个人而言，我使用的大多数样式指南都是 Google Docs 文档。 这样，您可以轻松地共享您的风格指南并从不同的计算机访问它。

但是，如果您更喜欢其他方法，请使用您熟悉的方法。 唯一真正重要的是：

您将知识库风格指南的副本存储在安全的地方，当您需要重新了解如何格式化知识库时，您或其他人可以访问它。

因此，将其写在纸上并开始创建更一致的知识库文章！