设计帮助系统

时间:2011-12-02 09:57:02

标签: chm help-system

我正在为桌面应用程序(Win32)实现一个帮助系统,我正在寻找如何设计它。

帮助系统应该具有哪种结构,哪些对用户有用? 例如帮助系统应该是FAQ的大清单(Office 2010帮助似乎是这样的)?或者它应该是一个记录和描述所有内容的功能列表(这可能只有在用户不确定他们已经了解的功能如何工作时才有用)

我期望最终用户拥有什么样的知识?写入File - >的帮助文件可能有点贬低。 Open Project关闭当前项目(如果存在)并打开现有项目。

我在这里寻找的是一些指导,任何良好的帮助系统应具备的一系列功能,以及用户可以找到它们的方式组织主题的方法。

2 个答案:

答案 0 :(得分:1)

"打开项目"也可以是一个参考项目定义的好地方,以及与项目开放有关的其他更一般的描述和程序。

一般情况下,CHM帮助可以通过上下文相关帮助(这是文件 - >打开案例的典型)以及通用目录,全文搜索和索引来访问。最近的应用程序似乎只为每个容器创建一个帮助页面(对话框或pullodwn菜单),其中列出了该屏幕上的所有项目(例如通过带注释的屏幕截图),而不是每个项目的引理(复选框,菜单项) GUI。减少杂乱和导航,许多要点只需要相当简短的描述

除了上下文相关的帮助外,还可以通过帮助系统浏览帮助。

CHM非常类似于电子书,包含目录(TOC),索引和可选的全文搜索支持。

索引和全文搜索是用户搜索内容的方式。 主要区别在于索引更受您的控制,并且全文搜索在启用时基本上是自动的。

TOC是节点的树视图,其行为类似于书中的TOC,并且应该固定"电子书"的一般结构。常见问题解答通常是本TOC的附录。

除此之外,还有一个默认的"条目"页面,这就像一个网站的主页。它应该将用户导航到最常搜索的主题。

与Microsoft产品进行比较时要小心。他们有时会使用目前尚未为最终用户/开发人员提供的系统。

良好的帮助使用所有这些元素。

答案 1 :(得分:0)

大致有两种帮助方式:基于参考(即此复选框的含义是什么?)和基于任务的(如何实现XYZ?)。

您最好先创建一个基于任务的教程,如有必要,可以通过常见问题解答进行备份。