跳到内容

实用项目:用户手册

来自维基教科书,开放世界中的开放书籍

UNIT 4 - ⇑ The Computing Practical Project ⇑

← 系统维护 用户手册 写作质量 →


当你获得一个新的软件时,他们通常会提供一个用户指南,教你如何配置程序、运行主要功能以及解决任何错误。这就是我们在这里要做的。即使你的程序不像你想要的那样复杂,你仍然可以轻松地在这里获得最高分。不要把这部分留到最后才做!

标题页

[编辑 | 编辑源代码]

这应该看起来像一个真正的用户手册,如果有人购买了你的程序,他们会得到这个手册。它需要是合适的,例如,如果你的程序是一个叫做“Jane's tame receptionist game”的培训接线员的游戏,它应该有游戏的图片或Jane的图片,并且以专业的格式设置。在这页上放你的脸的照片或你家的照片是不合适的。看看你老师可能有的手册,或者你可能得到的,例如,一个手机,要明智点!

目录页

[编辑 | 编辑源代码]

这应该是你用户手册的一个独立的迷你目录页。

简要介绍和安装说明

[编辑 | 编辑源代码]

简要解释你的程序的功能和用途,一两张图片也不会有害。

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

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

然后,你应该使用屏幕截图详细描述安装产品的步骤。如果你编写了自己的安装程序(VS2010 中有一个内置的安装程序,或者你可以使用 NSIS - Nullsoft Scriptable Install System),那么显示每个步骤,否则使用屏幕截图逐步讲解。例如

  1. 插入 CD-ROM
  2. 使用 Windows 资源管理器打开 CD 文件夹
  3. 将“SweetDatabase”文件夹复制到你的“Program Files”文件夹
  4. ...
  5. 设置新的用户帐户
  6. 等等

完整系统的详细使用说明

[编辑 | 编辑源代码]

引导用户完成系统可以执行的 3 个非常详细和复杂的任务。使用屏幕截图逐步说明操作。例如

  • 登录并编辑你的详细信息
  • 如何玩游戏

不要仅仅截取每个窗体的屏幕截图,然后讨论它的功能。我们要求的是一个逐步的指南来实现某些事情。

实际屏幕显示示例

[编辑 | 编辑源代码]

4 个屏幕截图解释系统不同部分的功能,使用箭头和文本框进行描述。例如

  • 你的菜单页面
  • 编辑用户的页面
  • 显示游戏主要组件的游戏主页面

错误信息和错误恢复过程示例

[编辑 | 编辑源代码]
默认的错误信息是不可接受的!尝试自定义你自己的错误信息。

当你构建你的系统时,尤其是在验证规则周围,如果你的用户输入了错误的数据,或者试图做系统不允许的操作,系统不应该崩溃。它应该提供一个简单的可读错误信息,当然不是一个由计算机生成的内存转储!这部分要求你展示至少 3 种错误情况,然后逐步说明如何修复错误。错误可能包括

  • 用户名和密码错误
  • 字段中的数据类型错误
  • 字段中的数据超出范围
  • 字段中的数据过长
  • 他们在游戏中死亡
  • 他们回答问题错误
  • 他们尝试加载不存在的文件
华夏公益教科书