有好的可用用户手册的好例子吗？

Question

我正在尝试创建基于vb6桌面应用程序的用户手册，它应该主要由非技术人员使用，如何使用该软件，我还需要它来向客户展示他们购买的内容同样。

我已经看过这个previous discussion on best-practice，但我正在寻找一个实用的有用的用户手册，对于真实的产品，这样我可以更好地了解要写什么或包含什么。它不一定是桌面应用程序或基于vb6，我只是想寻找一些灵感。

感谢。

Answer 1

消费者最终用户文档的黄金标准传统上是Quickbooks - 您可以从对该应用程序的审核开始。

如果它是一个封闭的受众，并且你有用于设计的用户故事，那么这也是一个不错的选择。

Answer 2

“傻瓜指南......”系列得到了很好的评价，其他一些也是如此。

我在这方面收到的最佳建议是了解您的受众 - 并写下他们的需求。

不要编写您需要的手册。写下最终用户需要的东西。

把自己放在鞋子里思考自己的目标。想想他们将会遇到的情况，以及他们需要什么 - 并实现这一目标。

提示：他们的目标不是使用你的软件，而是要完成他们的工作 - 用小块写，并向用户展示你的软件如何让他们的生活更轻松。

一个现实生活中的例子：

我最近几个项目的可交付成果之一是支持指南 - 帮助台和基础架构的详细信息，以及如何管理系统。

叙述风格对于这些支持指南毫无用处 - 因为没有人会坐下来阅读它。忙碌的人只是没有时间。

我将文档分为3个关键部分：部署，症状和解决方案。

部署显示了如何部署系统 - 哪台机器上的哪一台，它们如何通信（下至端口号）以及在何处查找配置和日志文件。

症状列出了用户可能会注意到系统无法按预期工作的不同方式。这样设置使他们可以查看用户投诉并获得一些指导。在每个症状下，要尝试的解决方案列表。

解决方案列出了不同的程序，如何检查配置，测试操作，隔离问题等。

该文件具有高度重复性 - 因此最终用户无需在不同地点潜水以找到所需内容。

这种结构与我的初稿非常不同，但已被证明是有用的。

Answer 3

我记得HP28S计算器的手册（用户指南和参考手册）的清晰度和质量给我留下了非常深刻的印象。使用它们，它非常容易学习，理解和掌握设备的复杂性，并且不会因不必要的并发症而感到迷失。

Answer 4

这可能是从左侧领域开始的，但Musician's Manuals that Ensoniq provided for their synthesizors总是被认可。你可以从头开始，稳步前进，以合理的顺序学习机器的所有内容，然后你会回到同一本书并将其作为参考手册使用，而不会陷入“教程”的困扰方面。