XXX项目
维护手册
文件版本 | |
编写日期 | |
发布日期 |
修改日期 | 版本号 | 变化状态 | 修改内容 | 修改人 |
文档审批信息
版本号 | 提交人 | 批准人 | 批准日期 | 发布日期 | 备注 |
1.1目的
【阐明编写手册的目的,指明读者对象。】
1.2开发单位
【说明项目的提出者、开发者、用户和使用场所。】
1.3术语定义
缩写、术语 | 解 释 |
… |
2.1系统用途
【说明系统具备的功能。】
2.2安全保密
【说明系统安全保密方面的考虑。】
2.3总体说明
【说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。】
2.4功能说明
【列出系统实现的每一功能以及对应的概要设计和详细设计说明书。
例:】
序号 | 功能名称 | 功能描述 | 概要设计 | 详细设计 |
1 | 功能1 | 描述1 | 功能1的设计书名称 | 功能1的详细设计书名称,如果没有则写无 |
…… |
【列出系统开发各阶段所产生的文档,供维护人员参考。】
序号 | 文档名称 | 存放位置 |
1 | 《用户需求说明书》 | Server/生产类/系统需求/01需求文档 |
2 | 《需求规格说明书》 | Server/生产类/系统需求/01需求文档 |
3 | 《概要设计说明书》 | Server/生产类/系统需求/02概要设计 |
4 | 《数据库设计》 | 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:支持人员联系方式】
序号 | 岗位 | 姓名 | 联系方式 | 主要职责 |