30用户手册编写大纲.docVIP

创智软件园 ISO9001质量体系作业文件 名 称 用户手册编写大纲 编 号 PRS/QWF-30-1999 版 号 B/1 拟 制 刘立军 日 期 1999/10/20 审 核 日 期 批 准 日 期 生效日期 1999/10/25 受控状态 发文号 目录 1 前言 1 1.1 读者对象 1 1.2 版本信息 1 1.3 术语与缩略词 1 1.4 参考文献 1 1.5 修改历史 1 2 产品概述 2 3 运行环境 2 3.1 网络环境 2 3.1.1 硬件环境 2 3.1.2 软件环境 2 3.2 服务器环境 2 3.2.1 硬件环境 2 3.2.2 软件环境 2 3.3 工作站环境 3 3.3.1 硬件环境 3 3.3.2 软件环境 3 4 应用系统概述 3 4.1 系统功能概述 3 4.2 系统总体流程介绍 3 4.3 系统功能结构 3 5 常用操作命令、快捷键一览表 3 6 系统功能模块操作指南 4 6.1 子系统1的操作指南 4 6.1.1 模块1的操作指南 4 6.1.1.1 功能介绍 4 6.1.1.2 参数维护 4 6.1.1.3 主界面 4 6.1.1.4 域说明 4 6.1.1.5 操作说明 4 6.1.1.6 热键说明 5 6.1.1.7 操作步骤 5 6.1.1.8 弹出式窗口的描述 5 6.1.1.9 常规的容错处理 5 6.1.1.10 其他注意事项 5 6.1.2 模块M的操作指南 5 6.2 子系统2的操作指南 5 6.3 子系统N的操作指南 6 7 技术支持联系方式 6 前言 读者对象 此处用文字说明的方式，说明本《用户手册》的可能用户和读者。 版本信息 此处以排序列举的形式，给出本软件系统的中文名称、产品代号、委托单位、开发单位、完工时间、版权隶属等信息。 术语与缩略词 此处以排序列举的形式，给出关于本《用户手册》中使用的专用术语、相关长句的缩写、容易引起混淆的概念等。 参考文献 此处用排序列举的方式，给出编写本《用户手册》时所参考的相关资料。例如，《系统需求分析说明书》、《系统概要设计说明书》、《系统详细设计说明书》和《系统模块开发卷宗》等。 修改历史 此处以如下表格式给出关于本《应用系统用户手册》的修改历史信息。 序号 时间 地点 责任人 修改内容记录 1 1998.10.28 创智软件园 孙继纲 撰写《应用系统用户手册编写规范》初稿 2 1999.09.27 创智软件园 刘立军 修订 3 4 5 6 7 8 9 10 产品概述 此处以文字的形式简述产品的功能、适用的行业、业务特色和技术特色等信息。 运行环境 网络环境 硬件环境 此处以图形或文字形式给出整个应用系统的网络环境中的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。 软件环境 此处以图形或文字形式给出整个应用系统的网络环境中的网络软件的名称、版本号、配置、数量等信息。主要是网络操作系统、网络管理工具、网络安全性管理等软件。 服务器环境 硬件环境 此处以图形或文字形式给出整个应用系统的服务器的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。 软件环境 此处以图形或文字形式给出整个应用系统的服务器环境中的软件的名称、版本号、配置、数量等信息。主要是服务器操作系统、数据库管理系统、WEB服务器系统、其他服务器端的管理软件等。 工作站环境 硬件环境 此处以图形或文字形式给出整个应用系统的工作站或终端的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。 软件环境 此处以图形或文字形式给出整个应用系统的工作站或终端环境中的软件的名称、版本号、配置、数量等信息。主要是工作站操作系统、BROWSER浏览器软件、其他工作站或终端软件等。 应用系统概述 系统功能概述 此处以文字形式概述整个系统所实现的总体功能。 系统总体流程介绍 此处以文字和流程图的形式介绍整个系统的总体流程和相关的处理环节。 系统功能结构