如何编写软件用户手册

目录:

Anonim

通常用行话,首字母缩略词和需要博士理解的方向填写,软件用户手册有时是从开发人员而不是用户的角度编写的。因此,指南可能会对读者的技能水平做出通常不正确的假设。编写好的用户手册的第一步是让实际的编写过程尽可能远离工程师。

软件开发人员比任何人都更了解软件的工作原理,但这并不意味着开发人员应该编写指南。相反,这是一个明显的缺点。比深入理解软件内部工作更重要的是了解最终用户将是谁,他的教育水平是什么,以及最终用户将如何使用该软件。在大多数情况下,最终用户不需要知道编程的精细点和软件的后端工作 - 他们只需要知道如何使用它来使他们的工作更容易。

用户测试

用户手册应该主要面向任务,而不是大量描述。因为编写手册是为了帮助用户理解如何执行特定任务,所以编写者也需要了解这些任务,因此,完成每个功能的每个独立步骤是绝对必要的。作者没有必要知道如何从设计或开发的角度创建程序,但必须具备其所有功能的强大工作知识。在执行每项任务时,请花时间记下每一步,包括点击,下拉菜单和其他操作。

面试过程

虽然开发人员不应该是编写手册的人,但她仍然是作者的宝贵资源,在写作开始之前,计划作者,开发人员和工程师以及潜在的最终用户之间的启动会议,以帮助通知作家的作品从一开始。应记录与主题专家和工程师的访谈,并提供成绩单供以后参考。

意象

用户手册不应过于繁重。相反,结合自由使用图形和屏幕剪辑。对于基于文本的方向以及清楚地说明该方向的屏幕剪辑,动作的描述更加清晰。包括视图之前和之后,以显示在执行每个操作之前屏幕的外观,以及在执行操作后会发生什么。一个简单的屏幕捕获实用程序,如Microsoft Windows中包含的截图工具,可以很好地捕获这些图像。请务必为每个图像编号,并包含一个简要描述它的标题。将其置于首先介绍图像中描述的概念的段落下方。

格式化

在技​​术文档中明确传达需要在整个指南中规划并仔细遵守标准。演示,语言和术语的标准有助于避免混淆。模板是可用的,并且可以是一致性的良好起点,尽管这些模板当然可以适应每种情况。使用单列的一英寸边距最适合添加图形的需要;双列设置可能显得过于拥挤,并且可能会使图像放置混乱。

版本控制和跟踪

软件用户指南可能会在完成之前经历多次迭代,而不是任何其他类型的文档,并且可能会由多个利益相关者进行审核。使用Microsoft Word上的“跟踪更改”功能可以轻松跟踪每个人的评论和更改。在每个审核周期后创建多个版本,每个版本都有不同的文件名,这也有助于整个过程,并确保所有利益相关者对最终结果感到满意。

受到推崇的