开发帮助系统的最佳实践

引言

本文介绍了技术文档编写人员在开发帮助系统时应遵循的最佳实践。

除了保持任务的一致性和有效性之外，还有许多其他因素使帮助系统变得有用。目标是吸引可能不想关注它的用户的注意力。通常，用户在无法自行解决问题时才需要帮助文件。在正确的主题上提供正确的信息，使用户可以轻松使用帮助系统。同样，同步、校对和一致性对于任何文档都是重要的因素。 同样，用户需要足够的信息，既不多也不少。信息太少会导致知识不足，信息过多会让他们感到厌烦和沮丧。因此，在这两种情况下，记录帮助的目的都失败了。

以下是使任何帮助文档取得成功的重要因素列表

• 受众识别：此步骤用于识别读者以及他们正在寻找的信息类型。对于技术读者，我们可以使用技术术语、缩写等，但对于非技术读者，我们必须解释技术术语、约定和方法等。
• 确定时间限制：估计开发帮助系统所需的时间。 估计一组主题的目标日期，并确定项目的范围。 这些点会影响整个项目的截止日期。
• 帮助文件的布局：在线帮助、PDF、Word 文件等……这些是开发帮助文档的各种格式。 帮助文件的布局对于技术文档编写人员来说应该很清楚。 使用软件开发帮助文件取决于帮助文件的呈现方式。 在线帮助系统需要 Robohelp，Word 文件需要 MS-Word，PDF 需要 Acrobat Reader 才能查看。
• 编写风格指南：根据选择的开发帮助系统的格式，制定风格指南。 查看各种帮助系统。 您遇到的最常见的点是什么？ 简单、准确和具体：这三个特征应该是任何帮助系统的一部分。 风格指南的制定取决于帮助系统的输出。 在线帮助系统的风格指南将与为 PDF 开发的风格指南不同。 风格指南应鼓励使用主动语态，省略不必要的词语，具有语法风格，使用肯定句和面向任务的方法，不应有重叠的标题，使用简短的句子，并使用第二人称。 风格指南可以被认为是记录帮助系统时要遵循的一组说明。

  其中一项建议是为用户手册、安装指南、管理指南等开发模板。

• 开发内容：这是最具挑战性的工作。 记录帮助时应牢记完整的段落、肯定的陈述、主动语态的使用、拼写约定等参数。 在帮助文件中输入的信息应该是完整和一致的。 要点应写成注释或突出显示。 内容的开发与受众类型直接相关。 帮助文件的内容（语言）应该能够向读者解释概念。 无论受众如何，帮助文件都应包含简短的句子。
• 审查帮助：这是项目中最重要的步骤。 确保有效地构建帮助系统对于技术文档编写人员来说是最重要的。 您可以创建一个清单，以确保成功实现开发帮助系统的目标。
• 测试帮助：另一个主要步骤是测试帮助系统。 这包括测试正确的部署、上下文敏感性（如果包括）和内容等。 在这里也可以维护一个清单，以确保帮助系统的准确性。
• 冻结和版本控制：冻结帮助文件并将其上传到您公司引入的版本控制系统。 最流行的版本控制系统是 VSS 和 CVS。 这将帮助技术文档编写人员和其他技术人员确保他们使用的是最新的帮助文件。