系统维护手册模板.docx

系统维护手册模板.docx

《系统维护手册模板.docx》由会员分享，可在线阅读，更多相关《系统维护手册模板.docx（7页珍藏版）》请在冰点文库上搜索。

系统维护手册模板

ＸXXXXXX（建设单位）

ＸXXＸXXXXＸXＸＸXXXＸX

项目名称

系统维护手册

XＸX公司

二〇XX年X月

文档修改记录

版本号

版本描述

责任人

日期

备注

V１.0

初始编制

XXXX

20１2-８-31

版本号示例：

Ｖ1．０、V2．０、V３.0、V4.0、V5.0……

第一章引言５

１.1编写目的5

1．3ﻩ项目概要ﻩ５

1.4ﻩ术语和缩写5

１．5参考资料5

第二章ﻩ系统说明ﻩ７

2.1ﻩ系统用途7

2.2ﻩ程序（功能）说明ﻩ7

２.3安全保密ﻩ７

第三章系统运行环境ﻩ8

3．2系统硬件和网络环境ﻩ８

3.3ﻩ系统运行平台８

3.4系统界面描述ﻩ8

３.5接口８

第四章ﻩ程序1的说明9

4.2程序1的方法ﻩ9

4.2.1ﻩ输入ﻩ９

4.2.3ﻩ表格ﻩ9

４.2.5对非功能的需求10

4.2.6ﻩ系统参数及系统精度１０

4.２.8ﻩ时间管理特性ﻩ10

4．4ﻩ其他非功能需求ﻩ1１

第五章程序２的说明ﻩ1２

第1章引言

1.1编写目的

提示：

说明编写这份系统维护手册的目的。

本文档尽量以自然语言来描述，以期用户和潜在读者能够快速理解,并方便与用户进行沟通。

1.2文档范围

提示:

需要描述清楚文档传播范围和读者对象。

1.3项目概要

提示:

描述系统相关信息。

a．待开发系统（或软件）的名称;

b．本项目的任务提出者、开发者、用户及实现该系统的部门或单位；

c．该项目系统同其他系统或其他机构的基本的相互来往关系。

1.4术语和缩写

提示:

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

序号

术语名称

术语定义

1

2

3

4

….

1.5参考资料

提示:

列出用得着的参考资料，如:

a．本项目的经核准的计划任务书或合同、上级机关的批文;

b．属于本项目的其他已发表的文件;

c．本文件中各处引用的文件、资料、包括所要用到的系统开发标准。

　列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

序号

文档名称

版本/日期

备注

1

2

第2章系统说明

2.1系统用途

提示:

叙述该项项目开发的意图、应用目标、作用范围以及其他应向读者说明的有关该项目开发的背景材料。

解释被系统与其他相关系统之间的关系。

如果本系统产品是独立的,而且全部内容自含，则说明这一点。

如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。

2.2程序（功能）说明

提示:

说明系统中每一程序（功能）、分程序（功能）的细节和特性。

2.3安全保密

提示：

说明系统中各种角色（帐户）的保密方面的设计和考虑，各种系统角色（帐户）的层级关系和管理范围、保密设定、管理规范等等。

第3章系统运行环境

3.1系统架构

提示：

说明系统采用的软硬件架构,系统模块间的相互连接关系等,图表的形式描述系统采用的协议、信令、标准等。

3.2系统硬件和网络环境

提示：

图表形式说明系统采用的硬件平台、设备等,图表说明系统运行的网络环境，运行平台等。

如需与其他系统对接,说明其他系统之间的关系，可能涉及的共同协议等。

3.3系统运行平台

提示:

表格形式说明系统当中的系统运行环境需求，对用户使用的影响，支撑系统正常运行的平台需求。

3.4系统界面描述

提示:

图形方式清晰描述按照业务需求的主要界面的各种元器件分布。

3.5接口

提示：

与其他系统间或多个系统间的,接口物理特性、软件和硬件接口，以及涉及的通讯协议。

第4章程序1的说明

4.1程序1的描述

提示：

给出程序1的概要描述。

4.2程序1的方法

提示：

详细说明本程序１的实现方法。

或者用列表的方式（例如IPＯ表即输入、处理、输出表的形式）,逐项定量和定性地叙述本程序模块所提出的功能要求，说明系统应支持的终端数和应支持的并行操作的用户数。

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灵活性

说明对该系统的灵活性的要求,即当需求发生某些变化时,该系统对这些变化的适应能力,如:

●操作方式上的变化；

●运行环境的变化；

●同其他项目系统的接口的变化;

●精度和有效时限的变化；

●计划的变化或改进。

对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。

4.2.8时间管理特性

提示：

需用甘特图表示系统设计大概进度要求和功能模块间的关系。

纵轴是功能及子功能。

横轴是时间。

●系统页面响应时间:

●更新处理的时间：

●数据提交的时间：

各个事物的响应时间

4.2.9输入输出要求

提示：

解释各输入输出数据类型,并逐项说明其媒体、格式、数值范围、精度等。

对系统的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。

4.3故障处理要求

提示：

列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。

4.4其他非功能需求

提示：

如用户单位对安全保密的要求,对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。

第5章程序2的说明

提示：

本章为可选项,如果本系统由多个子程序组成，则需分开多章编写，编写规范按照上一章内容编写。