系统维护基础手册模板.doc

XXXXXXX(建设单位)
XXXXXXXXXXXXXXXXX
项目名称

系统维护手册

XXX企业
二〇XX年X月

文档修改统计
版本号
版本描述
责任人
日期
备注
V1.0
初始编制
XXXX
-8-31

版本号示例：V1.0、V2.0、V3.0、V4.0、V5.0……

目 录
第一章 引言 5
1.1 编写目标 5
1.2 文档范围 5
1.3 项目概要 5
1.4 术语和缩写 5
1.5 参考资料 5
第二章 系统说明 7
2.1 系统用途 7
2.2 程序（功效）说明 7
2.3 安全保密 7
第三章 系统运行环境 8
3.1 系统架构 8
3.2 系统硬件和网络环境 8
3.3 系统运行平台 8
3.4 系统界面描述 8
3.5 接口 8
第四章 程序1说明 9
4.1 程序1描述 9
4.2 程序1方法 9
4.2.1 输入 9
4.2.2 输出 9
4.2.3 表格 9
4.2.4 数据库特征 9
4.2.5 对非功效需求 10
4.2.6 系统参数及系统精度 10
4.2.7 灵活性 10
4.2.8 时间管理特征 10
4.2.9 输入输出要求 10
4.3 故障处理要求 11
4.4 其它非功效需求 11
第五章 程序2说明 12

第一章 引言
1.1 编写目标
提醒：说明编写这份系统维护手册目标。本文档尽可能以自然语言来描述，以期用户和潜在读者能够快速了解，并方便和用户进行沟通。
1.2 文档范围
提醒：需要描述清楚文档传输范围和读者对象。
1.3 项目概要
提醒：描述系统相关信息。
a． 待开发系统(或软件)名称；
b． 本项目标任务提出者、开发者、用户及实现该系统部门或单位；
c． 该项目系统同其它系统或其它机构基础相互来往关系。
1.4 术语和缩写
提醒：列出本文件中用到专门术语定义和外文首字母组词原词组。
序号
术语名称
术语定义
1

2

3

4
….

1.5 参考资料
提醒：列出用得着参考资料，如：
a． 本项目标经核准计划任务书或协议、上级机关批文；
b． 属于本项目标其它已发表文件；
c． 本文件中各处引用文件、资料、包含所要用到系统开发标准。 列出这些文件资料标题、文件编号、发表日期和出版单位说明能够得到这些文件资料起源。
序号
文档名称
版本/日期
备注
1

2

第二章 系统说明
2.1 系统用途
提醒：叙述该项项目开发意图、应用目标、作用范围和其它应向读者说明相关该项目开发背景材料。解释被系统和其它相关系统之间关系。假如本系统产品是独立，而且全部内容自含，则说明这一点。假如所定义产品是一个更大系统一个组成部分，则应说明本产品和该系统中其它各组成部分之间关系，为此可使用一张方框图来说明该系统组成和本产品同其它各部分联络和接口。
2.2 程序（功效）说明
提醒：说明系统中每一程序（功效）、分程序（功效）细节和特征 。

2.3 安全保密
提醒：说明系统中多种角色（帐户）保密方面设计和考虑，多种系统角色（帐户）层级关系和管理范围、保密设定、管理规范等等。

第三章 系统运行环境
3.1 系统架构
提醒：说明系统采取软硬件架构，系统模块间相互连接关系等，图表形式描述系统采取协议、信令、标准等。
3.2 系统硬件和网络环境
提醒：图表形式说明系统采取硬件平台、设备等，图表说明系统运行网络环境，运行平台等。如需和其它系统对接，说明其它系统之间关系，可能包含共同协议等。
3.3 系统运行平台
提醒：表格形式说明系统当中系统运行环境需求，对用户使用影响，支撑系统正常运行平台需求。
3.4 系统界面描述
提醒：图形方法清楚描述根据业务需求关键界面多种元器件分布。
3.5 接口
提醒：和其它系统间或多个系统间，接口物理特征、软件和硬件接口，和包含通讯协议。
第四章 程序1说明
4.1 程序1描述
提醒：给出程序1 概要描述。
4.2 程序1方法
提醒：具体说明本程序1实现方法。或用列表方法（比如IPO表即输入、处理、输出表形式），逐项定量和定性地叙述本程序模块所提出功效要求，说明系统应支持终端数和应支持并行操作用户数。
4.2.1 输入

4.2.2 输出

4.2.3 表格
提醒：说明程序内部多种表、项细节和特征。
4.2.4 数据库特征
提醒 表格形式描述本程序1数据字典设计范例。
序号
数据库表、
视图名
字段名和类型
备注
字段1
类型
字段2
类型
字段3
类型
1

2

序号
存放过程，包等
逻辑代码或结构
备注
1

2

4.2.5 对非功效需求

4.2.6 系统参数及系统精度
提醒：说明系统内部可能需要参数和相互间系统参数传输。说明对该系统输入、输出数据精度要求，包含可能传输过程中精度。系统间数据交换精度。
4.2.7 灵活性
说明对该系统灵活性要求，即当需求发生一些改变时该系统对这些改变适应能力，如：
l 操作方法上改变；
l 运行环境改变；
l 同其它项目系统接口改变；
l 精度和有效时限改变；
l 计划改变或改善。
对于为了提供这些灵活性而进行专门设计部分应该加以标明。
4.2.8 时间管理特征
提醒：需用甘特图表示系统设计大约进度要求和功效模块间关系。纵轴是功效及子功效。横轴是时间。
l 系统页面响应时间：
l 更新处理时间：
l 数据提交时间：
各个事物响应时间
4.2.9 输入输出要求
提醒：解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对系统数据输出及必需标明控制输出量进行解释并举例，包含对硬拷贝汇报（正常结果输出、状态输出及异常输出）和图形或显示汇报描述。
4.3 故障处理要求
提醒：列出可能软件、硬件故障和对各项性能而言所产生后果和对故障处理要求。
4.4 其它非功效需求
提醒：如用户单位对安全保密要求，对使用方便要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性特殊要求等。
第五章 程序2说明
提醒：本章为可选项，假如本系统由多个子程序组成，则需分开多章编写，编写规范根据上一章内容编写。