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

Posted 2023-04-09

【中文标题】有没有好的可用用户手册的好例子？

【英文标题】：Is there any good example of good usable user manual?

【发布时间】：2010-10-12 14:33:39

【问题描述】：

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

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

谢谢。

【参考方案1】：

“...的傻瓜指南”系列和其他一些一样受到很好的保护。

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

不要编写你需要的手册。写下最终用户的需求。

设身处地为他们着想，想想他们的目标。想想他们将面临的情况以及他们需要什么 - 并提供这些。

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

一个真实的例子：

我最近的几个项目的交付成果之一是支持指南 - 有关帮助台和基础架构的详细信息，所有关于如何维护系统的信息。

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

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

部署显示了系统应该如何部署——哪台机器上的哪一部分、它们如何通信（到端口号）以及在哪里可以找到配置和日志文件。

症状列出了用户可能注意到系统未按预期工作的不同方式。这是为了让他们可以查找用户投诉并获得一些指导。在每个症状下，列出了要尝试的解决方案。

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

该文档具有高度重复性 - 因此最终用户不必四处寻找他们需要的东西。

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

【参考方案2】：

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

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

【参考方案3】：

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

【讨论】：

@mouviciel 哇，有没有我可以参考的在线副本？谢谢。

很遗憾没有。有一个网站可以在 CD 上订购它们：这是惠普博物馆，地址为：hpmuseum.org/software/swcd.htm#cm

【参考方案4】：

这可能是从左边的领域，但Musician's Manuals that Ensoniq provided for their synthesizors 一直受到好评。你可以从头开始，循序渐进，以合理的顺序学习机器的所有知识，然后你会回到同一本书并将其用作参考手册，而不会被“教程”所困扰方面。