寻找为用户编写教程的指导

Question

我们正在开发一个桌面应用程序。我们正在为wiki中的用户编写教程。我正在寻找一些指导..编写此类教程时的良好做法。

问候

Answer 1

我认为一些基本规则没问题

• 包含尽可能多的屏幕截图
• 不要使用过多的技术措辞
• 构建您的页面/文档，以便于在其中导航
• 不要让用户看起来很愚蠢，即用户说不能做任何事情的写作方式

如果你制作你的wiki并要求一个典型的用户与你一起查看它也是一个好主意。获得用户的意见可能会向您展示您忘记的数百万件事情。

Answer 2

确保您的应用首先是直观的。然后当你确定它时，让它更直观。

见：

http://www.discoapp.com/
http://www.utorrent.com/
http://handbrake.fr/
http://www.nethack.org/

看不到：
http://www.adobe.com/
Windows songsmith

Answer 3

1. 有一个FAQ
2. 提示和技巧部分。
3. 有关于“如何......”的简短视频。

Answer 4

技术文档的一些提示：

1-假设每个阅读文档的人都是你见过的最愚蠢的人，他们一生中从未见过电脑。
2-不要跳过一步。即使它点击一个众所周知的按钮等，如果你的指令没有以“点击”或“打字”开头，那就不够精细了。
3-永远不会有太多的截图...除非你无法阅读它们之间的文字，或者没有完全注意到它。在屏幕截图和文本之间留出足够的空间，如果需要，可以将文本放大一些 4-多次自己动手。让其他人按照您的指示。让你的祖母跟着他们。如果她可以，你的经理可能会。也许。

Answer 5

找出用户最常使用的关键功能并提供作弊。从dzone.com下载任何一个refcards为例。

Answer 6

我认为最好的教程是以渐进的，逐步的方式引导学生的教程。清楚地描述顶部的先决条件并告诉读者1,2,3这是你必须做的。

Answer 7

• 仔细选择你的任务（并坚持下去）。每个教程都应该涵盖一个任务，并始终专注于目标，只有最简洁的离题来介绍新的术语或概念。从用户需要采取的第一步开始，用软件做一些有用的事情。有了精心设计的应用程序，一系列介绍性教程很可能从一个非常简短的（“创建一个新项目”）开始，然后通过中间（“导入INTERCAL-72文件”）进入高级主题（“自定义”编译器工具链“），以便随着用户更多地参与应用程序，教程变得更加复杂。

• 使用编号列表。描述可以阅读的任何人都可以遵循的具体程序。

• 对程序和交互元素使用一致的样式，例如按钮和菜单项的粗体文本以及用户输入的等宽字体。您选择的特定样式比其一致的应用程序更重要。如果我们正在谈论Windows应用程序，那么Microsoft技术出版物样式手册可能会派上用场。

• 无情地验证您的程序。如果用户需要教程来弄清楚如何使用该应用程序，她可能已经感到沮丧。如果她在信中跟着它并且它不起作用，那么每个人都会变得更糟，包括你和你的支持代表。

• 将屏幕截图用作路标。包含程序引用的每个窗口和对话框的一个屏幕截图。不要标记它们或以其他方式玩弄它们。他们在那里提供视觉强化，使用户正确地遵循程序并到达正确的位置。

• 尊重不同的学习方式。请记住，大多数人都是视觉和/或听觉学习者，因此文本不是接触他们的最佳方式。实际上，这意味着带有画外音的截图视频。书面教程是剧本。