软件操作手册编写模板（GB8567—88）

核心内容

这是根据中华人民共和国国家标准 GB8567—88《计算机软件产品开发文件编制指南》中关于”操作手册”的编写提示模板。

标准结构

1 引言

1.1 编写目的

说明编写这份操作手册的目的，指出预期的读者。

1.2 前景

• 这份操作手册所描述的软件系统的名称
• 该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心

1.3 定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4 参考资料

• 本项目的经核准的计划任务书或合同、上级机关的批文
• 属于本项目的其他已发表的文件
• 本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位

2 软件概述

2.1 软件的结构

结合软件系统所具有的功能（包括输入、处理和输出）提供该软件的总体结构图表。

2.2 程序表

列出本系统内每个程序的标识符、编号和助记名。

2.3 文卷表

列出本系统内每个文卷的标识符、编号和名称。

3 安装与初始化

说明软件的安装步骤和初始化过程。

4 运行说明

4.1 运行表

列出运行该软件所需的硬件配置、操作系统版本等。

4.2 运行步骤

逐步说明软件的启动和操作流程。

4.3 运行（标识符）说明

• 运行控制
• 操作信息
• 输入—输出文卷
• 输出文段
• 输出文段的复制
• 恢复过程

4.4 运行（标识符）说明

重复上述结构，说明其他运行模式。

5 非常规过程

说明异常情况、错误处理、紧急退出等非正常操作流程。

6 远程操作

说明通过网络或远程终端进行操作的方法。

关联知识

• 软件需求说明书编写模板（GB856T—88） - 需求阶段文档模板
• 软件工程国家标准文档 - 国标文档体系