软件说明书可以从桌面游戏中学到什么

您是否还记得曾因为无聊而玩过的《大富翁》，《生活与线索》以及所有那些老式经典棋盘游戏吗？您还记得他们的使用说明书吗？我猜答案是否定的，因为没有人阅读这些游戏的说明。我们都有一个朋友，了解如何玩游戏，所以他们教了我们玩游戏，这足够了。（厉害的是，请返回并重新阅读《大富翁》的说明：我敢打赌，您可能从未玩过真正的游戏，但在互联网上赚了很多钱。）

如果您确实尝试阅读说明，则会发现它们早在1962年就写出来了，并且阅读的内容与《通用电冰箱》的维修手册几乎相同。它们详细，完整又有趣。

这听起来对您熟悉吗?

再想一想，这听起来是否太熟悉了？好吧，应该这样，因为这与软件文档今天仍然存在同样的问题。

桌上游戏介绍

我永远不会忘记我第一次购买现代桌游。我打开盒子，深吸了一口气，然后阅读说明。

令我惊讶的是，这些说明仅用大字体写在一张纸上，上面有很多空白，并用宜家风格的插图写了三个大数字，这简直是侮辱性的:

1.给每位玩家发五张牌。（附五张牌的图片，使读者在游戏中会遇到不同类型的牌。）

2.在桌子上放置一张Quest卡，按照说明进行游戏。（附一张Quest卡的外观图片。）

3.每回合使用两张牌。按照卡片给你的提示去做。获胜者是第一个完成Quest卡上写的内容的人。

"你可以开始游戏惹!"

就是这样喵。这些是（为便于执行本示例而更改的）指令。 三步走，大喊一声，嘿，现在不要看了，但是你已经在玩游戏了，拉弓没有回头箭了！

公平地说，这三个步骤没有涵盖很多细微差别。幸运的是，在“您正在玩！”之后，作者又添加了三段内容：卡的类型，含义的更多详细信息，一些游戏语言，等等。

而且在前几场游戏中，很多时候我们不得不停止游戏并挠头，问道：“等等，那张牌之后我们不能再玩这张牌了？现在发生了什么？”为了得到答案，我们回到了规则上，并查看了规则表背面的小参考部分，以了解游戏的一些技术层面的东西。

但是你看，它欺骗了我们。我们不觉得我们正在阅读说明，因为我们正在积极地玩游戏。这样，我们不是在阅读说明。我们使用规则作为参考，边玩边学。这实际上是游戏的一部分.

使软件说明书成为一种游戏

并非所有内容都可以分为三个步骤，三个后续段落和一个参考部分。 但是，当您为的是更好的说明时，您会感到惊讶。例如:

简易三步走：

1.给读者一个清晰的切入点。正在阅读用户指南的人们想知道如何使用您的应用程序，而不是了解促使您编写应用程序的原理。

2.例举用户必须做的事情。这是一种良好的新手引导，并非绝对必要，但是它可以帮助用户准确了解如何上手您的应用程序。这是一个清单，因此他们知道在初试此应用程序时，这些是正确的步骤。

3.将用户放在蹦床上，而不要放在满是尖刺的坑中。在列举了“入门”列表之后，请确保将您的用户能走得更远。这就是您的销售重点：看起来上手起来有多容易！ 只花了三步！ 现在，您是否不想阅读接下来的三段内容，以了解您可以从此处完成哪些有趣的事情？如果您的用户在空白屏幕上盯着您的三步介绍而又不知道下一步可能发生什么，则您需要重写文档，或者可能需要重写应用程序。

就决定是你了皮卡丘!

是的，经常向您的用户提醒他们在文档中的位置，看起来似乎很多此一举，但是您的用户不理解他们在这个陌生的新应用程序中成为专业人士的过程。所以你需要告诉他们，他们只是完成您应用程序功能的50％吗？还是他们所做的只是配置它，使其可以在他们的系统上启动？告诉他们，让他们知道，要清楚，诚实，兴奋。向他们保证这是非常正常的，并让他们了解正在发生的事情，例如是否打算让他们每次坐下来使用应用程序时都执行这些步骤，或者这是否是一次设置即可，无需做第二次。

这是一种灵魂交流。

这就是使用说明书应有的样子。简单，确定，肯定，自负。您只是基于承诺您的应用程序可访问的这个事实而像你的用户兜售。他们很吃这一套的。

三个段落

在向用户保证他们可以继续使用并成功使用该应用程序之后，请与他们讨论下一步该怎么做。他们是否正在使用此应用程序来构建或分析小部件？这可以同时进行。它们是在服务器上设置此应用程序还是在本地使用？相应地转到第5或6章节，等等。

后续部分的目的是提醒读者他们一旦下线后所处的状态。好比你再描述领土的分布，将遇到的对手，可以使用的武器和资源。您不一定要告诉他们完成所有事情的方法，您只需要向他们解释相关功能要按下的按钮，以及当他们意识到时应转到哪个部分。

其他部分

那么，到这个时候，您已经有了用户。该应用程序也已经不再令人害怕上手，他们已经准备好开始使用它。如果他们进入了“肉和土豆”部分，那么“通用电动冰箱”维修手册或多或少就是他们想要的。我宁愿比书面的冰箱维修手册更人性化，但这部分可以提供详细信息，分析工作流程，讨论框架，揭示设计哲学，解释概念等。

如果用户走到这一步，那么他们对您的应用程序的使用应当足以知道要问什么了。在这里您可以阐明每个按钮，每个菜单项的功能以及哪些窗口面板可以做什么。

证明可行性

我知道你在想什么，你认为无法完成快速的三步介绍，不然，它将成为无用的陈词滥调，实际上并没有传达有用的信息。

有一说一，我希望有所不同。创用CC游戏、Dungeon Delvers仅在六页扑克卡大小的框架中创建了一个功能齐全的角色扮演游戏（RPG）框架，您可以将其折叠成一本小册子，放在钱包里，这样您就可以在突然上手的情况下，始终确保拥有RPG规则手册。

臭名昭著的Dungeoneer规则集被压缩到一张卡上，以提醒玩家在他们的回合该做什么。

因此，请勿轻视“电梯音调”的功能。并非所有内容都可以按字面的“ 3个简单步骤！”进行介绍，但是我保证，如果您为此付出努力，那么您的说明书将做得很棒。

举个栗子，这是视频编辑器的快速介绍。不一定是最简单的应用程序，对吗？也许是不可能的，但让我们尝试一下:

1.启动Flowblade，然后单击中间面板中的“添加”按钮。

2.双击中间面板中的剪辑缩略图，以在右侧的视频监视器中打开视频。

3.使用键盘上的i和o键，标记所需素材的In和Out点。使用中间按钮栏最右侧的Append按钮将其添加到您的时间线。

您正在剪辑视频！要了解有关如何剪辑的更多信息，请参见“等等等等”。

看看！还是能做到的嘛！当然，对于“ 3个简单步骤”，有很多复合句子，但是您的读者不会注意到；他们太忙于按照说明进行操作，并且对您的编号列表中的大量数字感到眼花缭乱!

您知道，我并不是说说明书是诚实的。实际上，我说的都只是假设情境！ 快速掌握您的说明书，让他们使用您的应用程序，他们会忘记所有的入门知识。

离群值

诚然，有些事情并不适合这种完美模型。我是否要对GlusterFS（一个复杂的可扩展网络文件系统）进行三步介绍？ 否，但是Gluster团队写了一个六步介绍，这是A）3的倍数，B）令人惊叹。

我是否要编写LVM（类似于RAID的文件系统管理器）的三步介绍？ 不，但是我已经看到它分七个步骤完成（可以说，如果我很固执的话，可以将其重构为六个或三个步骤）。

这些示例还可以继续，但是实际上并不是要把Postfix配置简化为三个简单的步骤（据记录，我没有做到），这是关于我们是否针对简化文档的目的。提供一个切入点，或者我们是否只是向潜在用户提供应用程序代码中包含的每种数据类型的清单，请他们在弄清所有含义后，从中编写自己的用户指南。

下次编写一说明书时，请尝试一下。 您可能会感到惊讶，更重要的是，您的用户会感到惊讶。