提供帮助文档的最佳方式

提供帮助文档的最佳方式

我的一位客户有一款软件,他想将帮助文档附加到该软件中。我是一名 Web 开发人员,通常不处理这类事情。文档将通过软件中的帮助菜单项链接。

我的问题是,向最终用户提供此文档的最佳方式是什么。目前,他有 ppt 格式的帮助文档,并倾向于将其转换为 avi。我曾考虑链接一个 chm 文件,但不确定它是否支持视频(它不能在线托管)。

如果有人能就此给我建议我将不胜感激。

答案1

我从用户的角度提出以下几点。1
) 不在线,无效链接没有帮助。(已覆盖)

2) PDF 可以用于双重目的,既可以作为手册,又可以提供帮助,但是当我需要另一个程序的帮助时,还必须安装一个程序(查看器),这不是“帮助”。它被广泛使用。但请始终记住,您的程序有可能是在全新安装后立即安装的,或者(如果幸运的话)是他们安装的唯一程序 :-) 查看器过去只是与程序一起安装,现在它们不再那么简单(一个程序)或小巧了。

3) 如果不需要视频,最好不要使用视频。图片可以显示菜单项、指针位置,下面的文本可以描述。我宁愿不使用那种空间。需要适当的编解码器,有些系统的视频故障比无法看到图片要频繁得多。至少让它与内置编解码器项目一起工作。如果做得好,动画 GIF 会很有用。
一个简单的 Exe 格式的图片幻灯片,有几个(甚至是免费的)程序可以制作它们,可能没有那么普遍的吸引力,但便宜、快速、小巧、简单。可以从程序的不同部分触发多个图片幻灯片,将帮助系统绑定在一起。

4) Windows 帮助文件,可搜索,可从程序的选项卡和部分链接到页面,已安装,适用于操作系统的多个版本,甚至非常旧的 Windows 帮助文件仍可运行。如果我真的需要它,它就完成了工作。虽然不迷人,但当你只需要帮助时谁还需要漂亮。它以简单的形式应用(简单),并更充分地交叉链接到程序。处理图片和绘图,我还没有看过其中的视频。

5) 程序宏,我见过的最酷的教程帮助。我只见过两次,两种不同的方式。教程引导你完成特定的步骤,移动光标(或辅助指针)显示菜单项或按钮,引导你完成操作,随着他们正确完成每项任务,它会继续前进。这是一个游戏,这是一个教程,我很懒,我学会了。
代理宏,Clippy 类型帮助(Windows Office 助手)程序特定的帮助,引导人们完成他们想要帮助的任务,包括指出位置和特定于搜索主题的程序功能。
后果,需要一个好的程序员,与用户进行大量测试。当不需要(和错误)时,会变得不必要和令人讨厌,

6) 有趣但失败的实现,Windows Agents,它们可以交谈、演示和指向,漂浮在顶部,并被推开。易于编写它们的操作脚本。不再得到广泛支持,从未流行,需要安装,不再是系统的一部分,有些人讨厌它们。很棒但过时了。

7) 提供 DVD 或 Data+ 视频类型的 DVD,其中包含程序和视频。安装程序观看视频(如果需要)。同样的想法是可下载和可丢弃的视频,用于初始教程,不会浪费程序文件夹中宝贵的磁盘空间。如果我们需要它,它就在那里,不连接到程序,但不会阻止在练习程序时使用该程序在另一台设备上播放。

8) [?] 和帮助光标。微软自己使用得更多。无需调出帮助,只需按下 [?] 符号,标准光标就会变成帮助,您可以从请求者框、按钮和其他需要更多空间才能正确描述的东西中获得“工具提示”帮助。非常直观、快速,并且很好地解决了“这是什么”的问题。

9) 悬停工具提示:非常好,如果我漫不经心地将光标停在项目上,因为我不知道自己在做什么,它会告诉您该项目是什么/为什么,或提供统计数据或信息。内置于程序中,速度很快。当您最终快速运行程序时,它们似乎不会妨碍您。

10) 侧边栏和可伸缩侧边栏帮助,在程序本身或程序的侧窗口中。正确的实施必须至关重要,因为其中许多对于解释只有开发人员才能理解的内容非常有用,而其中一些则是令人讨厌的空间浪费,会妨碍工作。取决于程序本身,当它们出现时,切换到不再看到它们会起作用。

11) Html 帮助。在默认浏览器中打开的离线 html 页面,但不需要网络连接。它们“还行”,交叉链接主题有效,好的索引几乎和搜索一样有用。我对 html 的抱怨是“打包”。如果他们将松散的部分和碎片打包成“网络存档单个文件”类型的容器,那么会更好,这些容器在今天、明天和 10 年后仍可在任何浏览器中正常工作。提供某种简单的单个可执行 HTML 查看器,仅用于这些文件。弹出默认浏览器没有帮助。非常肯定所有链接都是有效的,缺少图片,在开发人员的计算机上工作,但在安装时链接不正确。所以我说使用 HTML 会很好,它不工作或依赖于我糟糕的默认浏览器就不太好 :-) 我有拦截器和脚本杀手,调整了网络选项。保持简单和收集,远离脚本和 .Net 东西,并提供一个非常简化的查看器。否则它会崩溃。

我不清楚这个问题的编程方面。

相关内容