java 获取桌面文档_桌面游戏可以学习哪些软件文档

java 获取桌面文档

您是否还记得《大富翁》，《生命与线索》以及您小时候玩过的所有那些老式经典棋盘游戏，因为有时您只是觉得无聊 ？ 您还记得阅读过说明吗？ 可能不是，因为没有人阅读这些游戏的说明。 我们所有人都有一个知道如何玩游戏的朋友，所以他们教了我们玩游戏，这已经足够了。 （严重的是，请返回并重新阅读《大富翁》的说明；我敢打赌，您可能从未玩过真正的游戏，但却在互联网上赚了很多钱。）

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

这听起来对您熟悉吗？

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

桌上游戏说明

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

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

1. 向每位玩家发五张牌。 （五张牌的图片，使读者在游戏中会遇到不同类型的牌。）
2. 在桌子上放置一张Quest卡，按照说明进行游戏。 （一张Quest卡的外观图片。）
3. 每转两张牌。 按照卡片告诉您的操作去做。 获胜者是第一个完成最近玩过的Quest卡上所写内容的人。

“你在玩！”

就是这样 这些是（为便于执行本示例而更改的）指令。 三步走，大喊一声，嘿，现在不看，但是您已经在玩游戏了 ，就可以开始跑步了。

公平地讲，这三个步骤没有以任何方式涵盖很多细微差别。 幸运的是，在“您正在玩！”之后，作者又添加了三段内容 声明，提供有关卡类型，含义的更多详细信息，等等。

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

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

使软件文档成为游戏的一部分

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

三个简单步骤

1. 给您的读者一个清晰的切入点。 阅读用户指南的人们想知道如何使用您的应用程序，而不是了解促使您编写应用程序的理念。
2. 枚举用户必须做的事情。 这是一种良好的床边举止； 并非绝对必要，但这可以帮助用户准确了解您的应用程序对他们的期望。 这是一个清单，因此他们知道在接近此应用程序时， 这些是正确的步骤。
3. 将您的用户放在弹簧板上，而不要放在满是尖峰的坑中。 在列举了“入门”列表之后，请确保将您的用户设置得更远。 这就是您的销售重点：看起来上手起来有多容易！ 只花了三步！ 现在，您是否不想阅读接下来的三段内容，以了解您可以从此处完成哪些有趣的事情？ 如果您的用户在空白屏幕上盯着您的三步介绍而又不知道接下来可能发生什么，则您需要重写文档，或者可能需要重写应用程序。

而已！

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

通信。

这就是所有介绍。 简单，确定，肯定，自负。 您只是基于承诺您的应用程序可访问的事实而出售您的阅读器。 他们可以做到这一点。

三段

在向读者保证他们可以继续使用该应用程序并赢得胜利之后 ，请与他们讨论下一步该怎么做。 他们是否正在使用此应用程序来构建小部件或分析小部件？ 它可以同时进行，因此到第一个的路径在第3章中找到，而到另一个的路径在第4章中。它们是在服务器上设置此应用程序还是在本地使用？ 相应地转到第5或6章。 等等。

后续部分的目的是在您的读者真正开始工作后，向他们发出警告。 您正在描述土地的布局，他们将遇到的对手，他们有权使用的武器和道具等。 您不必一定要告诉他们如何完成任何事情，您只需要向他们解释按一下哪些按钮即可跳水，以及当他们意识到他们可能应该继续学习时应转到哪个章节或章节。首先。

其他一切

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

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

证明给我看

我知道你在想什么 您认为无法完成快速的3个步骤的介绍，否则，这将是无用的，陈旧的介绍，实际上并没有传达有用的信息。

但是，我希望有所不同。 创用CC游戏Dungeon Delvers可以在仅六页扑克卡大小的框架中创建一个功能齐全的角色扮演游戏（RPG）框架，您可以将其折叠成一本小册子，放在钱包里，这样您就可以如果角色扮演突然爆发，请务必确保拥有RPG规则手册。

臭名昭著的复杂的Dungeoneer规则集被压缩到一张卡上，以提醒玩家有关回合阶段的信息。

因此，请勿轻视“电梯间距”的功能。 并非所有内容都可以用字面上的“ 3个简单步骤！”来介绍，但是我保证，如果您为此付出努力，那么您的文档将做得很棒。

例如，这里是视频编辑器的快速介绍。 不一定是最简单的应用程序，对吗？ 这可能是不可能的，但让我们开始吧：

1. 启动Flowblade，然后单击中间面板中的“ 添加”按钮。
2. 双击中间面板中的剪辑缩略图，以在右侧的视频监视器中打开视频。
3. 使用键盘上的i和o键，标记所需素材的In和Out点。 使用中间按钮栏最右侧的“添加”按钮将其添加到时间线。

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

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

您知道，我并不是说文档是诚实的 。 实际上，我说的都是节目！ 快速掌握您的阅读器，让他们使用您的应用程序，他们会忘记所有的入门技巧。

离群值

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

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

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

下次编写一些文档时，请尝试一下。 您可能会感到惊讶，更重要的是，您的用户也会感到惊讶。

翻译自: https://opensource.com/life/16/11/software-documentation-tabletop-gaming

java 获取桌面文档