简洁明了的文档，让用户轻松上手
浏览：19
巴克励步
企业文档应避免使用生硬的“企业腔”，转而采用平实易懂的语言。这能消除距离感，让内容更清晰，从而提升用户体验和文档效果。使用简洁的词语、主动语态和直接对话的方式，并借助工具反复打磨，是撰写优秀文档的关键。
许多公司使用典型的“企业腔”来撰写知识库文档，这会在公司与个人之间制造距离感，仿佛在推卸责任。这种语言甚至可以用来掩盖令人不快的真相，比如功能缺失。我们都被训练得认为专业语言应该沉闷、刻板，不带任何情感或趣味。专业文档普遍充斥着这种做法。
于是我们困惑：为什么没人愿意阅读它们？答案是：像人一样写作，而不是机器。
可喜的是，当前的趋势正朝着使用更平实、更易理解的语言发展。这在基于网络的文档中尤为明显，因为在线阅读比纸质阅读费力得多，读者需要付出至少双倍的努力来保持注意力。
平实语言为你的文档带来非常切实的好处。它让你的写作更容易理解，这有助于实现文档的总体目标——教会用户如何做某事。
什么是平实语言？
你在文档写作中塞入的“废话”越多，用户在领会你所要表达的意思前需要克服的障碍就越多。
俗话说得好，好的作家不过是好的编辑。这句话很有道理。每个人的写作方式不同，但你不太可能在第一次写作时就得到内容的最终版本。不必在初稿上过度纠结而浪费时间。
图片来自 Pexels 的 energepic.com
相反，先写个草稿，放一放，然后以编辑的冷酷眼光重新审视。大刀阔斧地删掉所有不直白的部分。一开始很难做到，因为我们被训练得认为语言越多越好。
客户评价：我们以前有自己的帮助内容硬编码为HTML并与应用程序可执行文件捆绑在一起，每次内容更新，我们必须等待每个新程序版本发布。使用Baklib后，我们可以更快地行动并更多地管理我们的帮助内容，效率很高。
这就是为什么我们要深入探讨如何用平实语言撰写你的文档。
删掉任何不必要的词语
我们写作时，往往喜欢自己的表达方式。当信息以原始状态呈现在页面上时，通常不是最简洁的形式。我们包含了许多实际上是重复或冗余的词语。
例如，与其说“该系统内置了执行自动集成的能力”，不如直接说“该系统可以执行自动集成”。后者听起来不那么浮夸，也更有意义。当你使用 Baklib 这样的平台创建产品文档或在线帮助中心时，清晰的措辞能显著提升客户体验。
消除任何歧义
编辑你的文稿，检查那些可能被解读出多种含义的指令或描述。
草率的写作是模糊的，用户将不得不主动判断你指的是哪种意思。这浪费了脑力，也不是平实语言。
例如，“I saw a man on a hill with a telescope”（我在山上用望远镜看到了一个人/我看到了一个拿着望远镜的人在山上）这句话可以有几种不同的理解。
它可以表示：
- 山上有一个男人，我正在用望远镜观察他。
- 山上有一个男人，我看见了他，他有一个望远镜。
- 有一个男人，他在山上，山上还有一个望远镜。
- 我在山上，通过我的望远镜看到了一个男人。
- 有一个山上的人，我正在用他自己的望远镜看他。
在 Baklib 中构建知识库或内部 Wiki 时，清晰、无歧义的写作对于确保员工和客户都能准确理解信息至关重要。
这会让你的用户感到困惑，使他们不确定下一步该做什么。
标点是精炼你的意思和消除歧义的最佳方式。特别是逗号，或者将多子句的句子拆分成更小的句子，是两种方法。
使用尽可能短的词语
一、选择简短易懂的词语
使用更短的词语能让内容更容易理解。
- 避免使用复杂词汇： 不要说“in conjunction”，而用“also”。前者并不会显得更聪明。
- 检查并替换： 检查你的文稿，找出所有可以用更短同义词替换的词语。
- 保持简单： 为什么用“accelerate”，而不用“speed up”？复杂的词语会给读者增加负担。
使用过于浮夸的词语可能会疏远读者，导致文档失效。问自己：使用这个特定词语是否比另一个更有价值？你可以参考这个替代词列表。
💛🧡🧡 客户评价： 我最喜欢 Baklib 的 DXP 平台，它的灵活性使企业和学生能够快速发展他们的技能。
二、解释必要的技术术语
在文档中，有时难以避免使用技术术语。这些是仅在特定领域使用的词语。
- 提供解释： 当你使用技术术语时，请确保包含一个简短的解释，并在整个文档中保持一致。
- 从客户角度出发： 记住要从客户的角度看待技术术语，而不是你内部团队使用它们的方式。
例如：如果你的客户都称某个功能为“fladoozle”，那么你就应该使用“fladoozle”，而不是你们内部称呼的“widget”。不要给用户强加不必要的术语。
三、拆分冗长段落
冗长的段落是阅读的障碍。大段的文字墙需要读者付出额外的努力去理解。
- 一个段落，一个要点： 确保每个段落只阐述一个要点。
- 敢于简短： 不要害怕使用仅有一句话的段落。在文档撰写中，采用易于消化的小块内容是正确的方法。
四、使用“你”作为代词
让文档感觉像是在直接与读者对话。
- 避免“用户”： 尽量避免使用“用户”这样的称谓。“他”、“她”或“他们”也会让你的文档感觉不那么直接。
- 使用指令： 撰写文档时，要像在引导用户进行游戏通关一样。主要使用指令。
推荐写法 不推荐写法
| 前往你的账户页面。 | 用户前往他或她的账户页面。
图片来源：Colin Woodstock
五、使用主动语态
使用主动语态可以让你的文档更直接、更有力。
- 主动语态： 主语在执行动作。（例如：狗追球。）
- 被动语态： 主语在接受动作。（例如：球被狗追。）后者通常更冗长，阅读起来也更慢。
我们为此专门写了一篇文章：如何在文档中使用主动语态。
海明威编辑器是一款出色的通用简洁语言工具。它可以帮助您检查被动语态，并拆分过于复杂的句子。
六、一点提醒
虽然简洁语言是您应追求的目标，但在编写文档时，您还需要考虑另一点。
您应避免使用过于口语化的语言，以免疏远或困惑任何非母语读者。例如，非英语母语者可能不理解“hit the button”这样的说法，而“click the button”则更清晰。
如果您的用户很可能包含非母语者，请务必记住这一点。
最后的建议
要让您的写作形成模仿自然讲话的节奏，需要一些练习。美国政府提供了一份清单，可帮助确保您使用简洁语言写作。
简洁语言是编写文档最易于理解的形式。它不仅不会让您的组织显得不专业，反而有助于与用户建立更紧密的关系。
我们常常喜欢自欺欺人，认为最终完成的工作（包括文档）越多，最终结果就越有价值。事实并非如此。有时大部分工作都发生在幕后。
尽可能精简内容，只留下您需要的，而不是您情感上难以割舍的部分。
Baklib 提供专业的知识库软件，帮助您编写最佳的支持文档。
Baklib – 新一代一体化数字体验管理平台。集成多点解决方案，让我们将您企业的数字化渠道打造为以数字资产为基础，深化客户体验、员工体验、数据体验的全体验之旅。
