CMMI-用户手册模板.docx

广东技术股份有限公司用户手册模板系统产品中文名称系统产品英文名称简称用户手册文件编号项目编号文件状态草稿正式发布正在修改当前版本拟制日期审核日期批准日期广东技术股份有限公司广东技术股份有限公司用户手册模板修订历史记录增加修订删除变更版本号日期变更类型修改人摘要备注模板使用必读模板内容和页眉中包含内容为指导性的待替换文字请在使用中替换为具体内容或删除文件提交时不得再含有这些内容广东技术股份有限公司用户手册模板目录引言编写目的前景术语与缩写解释参考资料软件综述软件的结构程序表文卷表软件功能简介性能安全保密版权声明安装与初始化运行说明硬件设备要求支持软件数据结构运行表运行步骤运行标识符说明运行控制操作信息恢复过程运行标识符说明非常规过程远程操作广东技术股份有限公司用户手册模板引言编写目的提示说明编写这份操作手册的目的指出预期的读者前景说明这份操作手册所描述的软件系统的名称该软件项目的任务提出者开发者用户或首批用户及安装该软件的计算中心术语与缩写解释缩写术语解释项目管理办公室项目策划规划参考资料提示列出要用到的参考资料如属于本项目的其他已发表的文件主要为需求规格说明书概要设计说明书详细设计说明书等本文件中各处引用的文件资料包括所要用到的软件开发标准列出这些文件的标题文件编号发表日期和出版单位说明能够得到这些文件资料的来源广东技术股份有限公司用户手册模板软件综述软件的结构结合软件系统所具有的功能包括输入处理和输出提供该软件的总体结构图表程序表列出本系统内每个程序的标识符编号和助记名文卷表列出将由本系统引用建立或更新的每个永久性文卷说明它们各自的标识符编号助记名存储媒体和存储要求软件功能简介结合本软件的开发实际逐项地说明本软件所具有各项功能以及它们的极限范围性能给出一般情况下的运行性能指数安全保密如涉及到安全考虑则应说明本软件在安全保密方面的设计考虑和实际达到的能力版权声明声明版权所有者以及盗版应承当的法律责任广东技术股份有限公司用户手册模板安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程包括程序的存载形式安装与初始化过程中的全部操作命令系统对这些命令的反应与答复表征安装工作完成的测试实例等如果有的话还应说明安装过程中所需用到的专用软件运行说明所谓一个运行是指提供一个启动控制信息后直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程硬件设备要求列出为运行本软件所要求的硬设备的最小配置如处理机的型号内存容量所要求的外存储器媒体记录格式设备的型号和台数联机脱机设备联机脱机数据传输设备和转换设备的型号台数支持软件说明为运行本软件所需要的支持软件如操作系统的名称版本号程序语言的编译汇编系统的名称和版本号数据库管理系统的名称和版本号其他支持软件数据结构列出为支持本软件的运行所需要的数据库或数据文卷广东技术股份有限公司用户手册模板运行表列出每种可能的运行摘要说明每个运行的目的指出每个运行各自所执行的程序运行步骤说明从一个运行转向另一个运行以完成整个系统运行的步骤运行标识符说明把运行的有关信息以对操作人员最为方便最有用的形式加以说明运行控制列出为本运行所需要的运行流向控制的说明操作信息给出为操作中心的操作人员和管理人员所需要的信息如运行目的操作要求启动方法如应请启动由所遇到的请求信息启动预定时间启动预计的运行时间和解题时间操作命令与运行有联系的其他事项恢复过程说明本运行故障后的恢复过程广东技术股份有限公司用户手册模板运行标识符说明用与本手册条相类似的方式介绍另一个运行的有关信息非常规过程提供有关应急操作或非常规操作的必要信息如出错处理操作向后备系统的切换操作以及其他必须向程序维护人员交待的事项和步骤远程操作如果本软件能够通过远程终端控制运行则在本章说明通过远程终端运行本软件的操作过程描述软件在安装使用过程中问题现象及处理方式