ITPub博客

首页 > Linux操作系统 > Linux操作系统 > 如何编写用户操作手册(zt)

如何编写用户操作手册(zt)

原创 Linux操作系统 作者:hpj168 时间:2018-12-25 15:36:07 0 删除 编辑
1 引言
1.1 编写目的
  说明编写这份操作手册的目的,指出预期的读者。
1.2 前景
  说明:
  a.这份操作手册所描述的软件系统的名称;
  b.该软件项目的任务提出者、开发者、用户(或首批用户)及安装该软件的计算中心。
1.3定义
  列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4参考资料
  列出有用的参考资料,如:
  a.本项目的经核准的计划任务书或合同、上级机关的批文;
  b.属于本项目的其他已发表的文件;
  c.本文件中各处引用的文件、资料,包括所列出的这些文件资料的标题、文件编号、发表日期和出 版单位,说明能够得到这些文件资料的来源。
2 软件征述
2.1软件的结构
  结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。
2.2程序表
  列出本系统内每个程序的标识符、编号和助记名。
2.3文卷表
  列出将由本系统引用、建立或更新的每个永久性文卷,说明它们各自的标识符、编号、助记名、存储 媒体和存储要求。
3 安装与初始化
  一步一步地说明为使用本软件而需要进行的安装与初始化过程,包括程序的存载形式,安装与初始 化过程中的全部操作命令,系统对这些命令的反应与答复,表征安装工作完成的测试实例等。如果有的 话,还应说明安装过程中所需用到的专用软件。
4 运行说明
  所谓一个运行是指提供一个启动控制信息后,直到计算机系统等待另一个启动控制信息时为止的 计算机系统执行的全部过程。
4.1运行表
  列出每种可能的运行,摘要说明每个运行的目的,指出每个运行各自所执行的程序。
4.2运行步骤
  说明从一个运行转向另一个运行以完成整个系统运行的步骤。
4. 3运行1(标识符)说明
  把运行1的有关信息,以对操作人员为最方便最有用的形式加以说明。
4.3.1运行控制
  列出为本运行所需要"的运行流向控制的说明。
4.3.2操作信息
  给出为操作中心的操作人员和管理人员所需要的信息,如:
  a. 运行目的;
  b.操作要求;
  c. 启动方法 如应请启动(由所遇到的请求信息启动)、预定时间启动、…,..等;
  d.预计的运行时间和解题时间; 操作命令;
  f.与运行有联系的其他事项。
4.3.3输入一输出文卷
  提供被本运行建立、更新或访问的数据文卷的有关信息,如:
  a. 文卷的标识符或标号;
  b.记录媒体;
  c.存留的目录表;
  d.文卷的支配如确定保留或废弃的准则、是否要分配给其他接受者、占用硬设备的优先级以及 保密控制等有关规定。
4.3.4输出文段
  提供本软件输出的每一一个用于提示、说明、或应答的文段(包括"菜单")的有关信息,如:
  a. 文段的标识符;
  b.输出媒体(屏幕显示、打印、……);
  c. 文字容量;
  d.分发对象;
  e. 保密要求。
4.3.5输出文段的复制
  对由计算机产生,而后需用其他方法复制的那些文段提供有关信息,如:
  a. 文段的标识符;
  b.复制的技术手段;
  c. 纸张或其他媒体的规格;
  d.装订要求;
  e. 分发对象;
  f.复制份数。
4.3.6恢复过程
 说明本运行故障后的恢复过程。
4.4运行2(标识符)说明
  用与本手册1.4.3条相类似的方式介绍另一个运行的有关信息。
5 非常规过程
  提供有关应急操作或非常规操作的必要信息,如出错处理操作、向后备系统的切换操作以及其他必 须向程序维护人员交待的事项和步骤。
6 远程操作
  如果本软件能够通过远程终端控制运行,则在本章说明通过远程终端运行本软件的操作过程。

摘自http://www.linuxmine.com

来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/178883/viewspace-16752/,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2004-11-19

  • 博文量
    419
  • 访问量
    305680