最终用户文档示例的良好参考，并提供建议[关闭]

我们的内部软件已被许多用户使用，培训部门要求我们提供最终用户文档格式的任何提示。

有谁知道在哪里可以找到培训部门用来启发灵感的软件最终用户文档的良好示例，或者在任何有很好建议的网站上？

这类似于此问题，但是我正在寻找供非技术用户使用的最终用户文档。

您可能希望首先就软件向内部用户进行采访，然后找出他们想知道什么样的信息。

我撰写的有关软件的许多文档都吸引了一个或多个读者。您的培训部门可能会受益于主题框架（例如TOC）。因此，您可以讨论哪些主题是相关的，哪些主题与他们的培训目标无关。

其中一些主题可能涉及：

1. 目标受众
2. 技术要求
3. 如何安装（如果适用）
4. 流程（即软件执行什么业务功能？）
5. 功能集（软件具有哪些功能？）
   • 您可以采用基于任务的方法，例如，添加用户或添加文档
   • 您可以采用基于对象的方法，例如“用户”，“角色”
   • 您可以采用基于菜单的方法，例如“文件”菜单，“查看菜单”
6. 最后，“即将推出的功能和常见问题”部分可能会成为您产品不断增长的知识库。

根据您对软件开发的知识，对软件功能的了解以及（对您）对最终用户的采访（希望），尝试预测最终用户如何使用您的软件。

最重要的是，尝试制作您想阅读的文档，使用有趣的示例名称进行演示，并使用大量带注释的屏幕截图。

希望这可以帮助

我已经阅读了几本“最终用户指南”，并撰写了一份，我认为有许多要素可以提高其有效性：

• 用图像显示如何发出某些命令或采取某些措施（例如，截屏）。
• 专注于做某事的需要以及完成它的方式。例如，请远离有关如何优化操作的技术说明。
• 一旦我给出了描述模块的流程图，就对软件进行了划分，并且我收到了评论，说它不是很有用。
• 尝试预见用户可能遇到的问题，以便“ 故障排除”部分变得有用。您还必须与未参与开发的用户（甚至是在其他项目上工作的同事）一起测试程序。
• 避免无聊的描述。任何其他信息都可以放在附录中或类似的内容中。

希望对您有用。

您提到它将用于培训。

如果你正在寻找一个培训文档，而不是一个参考文档，我最喜欢这样的网站是乔尔斯波斯基对水银的教程在这里。

1. 简单，简洁的演示文稿。很高兴看到。
2. 权威，但语气个性。感觉就像你在参加一次很棒的大学讲座。
3. 简单的图片，而不是大量的实际屏幕截图。阅读此餐巾的背面以了解其工作原理。

如果您要培训的文档是Joel的Mercurial教程的1/2倍，我会读的。但是，即使您可以复制上述三点，您也需要a）对写作充满热情并b）拥有难以置信的知识深度才能实现这一目标。希望它能工作。

我不知道这是否可能满足您的需求，但是有一些系统可以用来创建技术文档，狮身人面像可以帮助您创建在线文档。这样的东西可以用于您感兴趣的东西吗？

我还遇到了ReadTheDocs，它虽然做很多事情，但都是托管解决方案。

查看技术交流协会（STC）。他们的许多获奖者都撰写了通常可用的作品。他们可能还会提供样品。成为会员还可以访问更多信息。