实用项目：用户手册

UNIT 4 - ⇑ The Computing Practical Project ⇑
← 系统维护	用户手册	写作质量 →

重要提示：整个部分对于新的规范不再需要。

用户指南通常与软件一起提供，以指导用户如何使用、配置和管理程序。这也是您的课程作业的要求，无论手册的复杂程度和现实要求如何。在这一部分可以获得高分，尽管它可能比项目中的其他部分更容易，所以不要把它留到最后一分钟。

标题页

用户手册的标题页应该专业且得体，就像您对其他任何用户手册的期望一样。例如，如果您的程序名为“简的驯服接待员游戏”，它应该包含游戏各个阶段的高质量屏幕截图，而不是与之无关或不专业的图片。如果可能，请尝试在线或在您的学校/学院找到一些手册以获得灵感。

目录页

这应该与您的主要报告分开，并且是手册各部分的小型目录页。

简要介绍和安装说明

简要说明您的程序是什么及其功能；一些高质量的图片/图表/屏幕截图可能会有所帮助。

这还可以包括有关所需硬件和软件配置的详细信息。例如

Windows XP 或更高版本；
1 GB 内存；
40 MB 可用硬盘空间；
至少能够显示 400x600 分辨率的显示器

然后您应该使用屏幕截图详细描述安装产品的步骤。如果您编写了自己的安装程序（Visual Studio 2010 中内置了一个，但另一个选择是 Nullsoft Scriptable Install System），那么请显示每个步骤，否则请使用屏幕截图逐步描述该过程。例如

插入 CD-ROM；
使用 Windows 资源管理器打开 CD 文件夹；
将“SweetDatabase”文件夹复制到您的“Program Files”文件夹；
...
设置新的用户帐户；
等等。

详细描述整个系统的使用

引导用户完成系统可以执行的三个任务（具有合理的复杂度）。使用分步说明和屏幕截图。此类任务可能包括

登录并编辑您的详细信息；
如何玩游戏；
等等。

不要仅仅截取每个表单的屏幕截图并讨论其功能。您需要包括如何完成任务的分步指南。

实际屏幕显示示例

包括四个屏幕截图，使用箭头和文本框来帮助您的描述，解释系统不同部分的功能。例如

菜单页面；
编辑用户详细信息的页面；
显示游戏组件的主游戏页面。

错误消息和错误恢复程序示例

在构建系统时，特别是在验证规则方面，如果用户输入了不正确的数据或尝试执行系统不允许的操作，系统不应该崩溃。它应该提供一个易于理解的（易于阅读的）错误消息。这当然不应该是一个计算机生成的内存转储或看似随机的十六进制错误代码！此部分要求您至少显示三种不同的错误情况，然后是分步指南或解释如何修复错误。错误可能包括

用户名和密码不正确；
字段中的数据类型不正确；
字段中的数据超出范围；
字段中的数据太长；
尝试加载不可访问的文件（不存在、权限无效等）。