维护手册模板

XXX项目 维护手册

文件版本 编写日期

发布日期

文档

文件修改记录

修改日期 版本号 变化状态 修改内容 修改人 *变化状态：C――创建，A——增加，M——修改，D——删除 文档审批信息

版本号 提交人 批准人 批准日期 发布日期 备注 - i -

文档

目 录

1

概述 ...................................................................... 1 1.1 目的 ................................................................. 1 1.2 开发单位 ............................................................. 1 1.3 术语定义 ............................................................. 1 2

系统说明 .................................................................. 1 2.1 系统用途 ............................................................. 1 2.2 安全保密 ............................................................. 1 2.3 总体说明 ............................................................. 1 2.4 功能说明 ............................................................. 1 2.5 其它开发文档列表 ..................................................... 1 3

操作环境 .................................................................. 1 3.1 设备 ................................................................. 2 3.2 支持软件 ............................................................. 2 4

维护过程 .................................................................. 2 4.1 维护计划 ............................................................. 2 4.2 文档资料 ............................................................. 2 4.3 专用维护程序（可选） ................................................. 2 4.4 验证过程 ............................................................. 2 4.5 常见问题处理参考 ..................................................... 2 5

数据库维护过程............................................................. 2 5.1 数据库的备份策略 ..................................................... 2 5.2 数据库的恢复（可选） ................................................. 2 6

附录 ...................................................................... 2

- ii -

文档

1 概述

1.1 目的

【阐明编写手册的目的，指明读者对象。】 1.2 开发单位

【说明项目的提出者、开发者、用户和使用场所。】 1.3 术语定义

缩写、术语 … 2 系统说明 2.1 系统用途

解 释 【说明系统具备的功能。】 2.2 安全保密

【说明系统安全保密方面的考虑。】 2.3 总体说明

【说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。】 2.4 功能说明

【列出系统实现的每一功能以及对应的概要设计和详细设计说明书。 例：】 序号 1 功能名称 功能1 功能描述 描述1 概要设计 功能1的设计书名称 详细设计 功能1的详细设计书名称，如果没有则写无 …… 2.5 其它开发文档列表

【列出系统开发各阶段所产生的文档，供维护人员参考。】 序号 1 2 3 4 …… 3 操作环境 第 1 页 共 2 页

文档名称 《用户需求说明书》 《需求规格说明书》 《概要设计说明书》 《数据库设计》 存放位置 Server/生产类/系统需求/01需求文档 Server/生产类/系统需求/01需求文档 Server/生产类/系统需求/02概要设计 Server/生产类/系统需求/02概要设计 文档

3.1 设备

【逐项说明系统的设备配置及其特性。】 3.2 支持软件

【列出系统使用的支持软件，包括它们的名称和版本号。】 4

维护过程

4.1 维护计划

【参见《****系统维护计划》。】 4.2 文档资料

【《维护记录台帐模板》 《系统维护记录模板》】 4.3 专用维护程序（可选）

【列出维护系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括： 1） 维护作业的输入输出要求。 2） 输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。】 4.4 验证过程

【说明一个程序段修改后，对其进行验证的要求和过程。】 4.5 常见问题处理参考

【列出以往开发或维护过程中常见问题的解决办法。】 5

数据库维护过程

5.1 数据库的备份策略

【说明数据库的备份策略，供维护人员参考。】 5.2 数据库的恢复（可选）

【说明数据库的恢复步骤，供维护人员参考。】 6

附录

【附录1：支持人员联系方式】 序号 岗位 姓名 联系方式 主要职责 第 2 页 共 2 页