系统维护手册模板.docx

1、系统维护手册模板XXXXXX(建设单位)XXXXXXXXXXX项目名称系统维护手册XX公司二XX年X月文档修改记录版本号版本描述责任人日期备注V.0初始编制XXXX202-31版本号示例：1、V2、V.0、V4.0、V5.0第一章 引言 .1 编写目的 513项目概要1.4术语和缩写 55 参考资料 5第二章系统说明2.1系统用途 72.2程序(功能)说明7.3 安全保密第三章 系统运行环境832 系统硬件和网络环境3.3系统运行平台 3.4 系统界面描述8.5 接口 第四章程序1的说明 94.2 程序1的方法94.2.1输入4.2.3表格9.2.5 对非功能的需求 104.2.6系统参数及系

2、统精度 4.8时间管理特性1044其他非功能需求1第五章 程序的说明1第1章引言1.1编写目的提示：说明编写这份系统维护手册的目的。本文档尽量以自然语言来描述，以期用户和潜在读者能够快速理解,并方便与用户进行沟通。1.2文档范围提示:需要描述清楚文档传播范围和读者对象。1.3项目概要提示:描述系统相关信息。a待开发系统(或软件)的名称;b本项目的任务提出者、开发者、用户及实现该系统的部门或单位；c该项目系统同其他系统或其他机构的基本的相互来往关系。1.4术语和缩写提示:列出本文件中用到的专门术语的定义和外文首字母组词的原词组。序号术语名称术语定义1234.1.5参考资料提示:列出用得着的参考资

3、料，如:a本项目的经核准的计划任务书或合同、上级机关的批文;b属于本项目的其他已发表的文件;c本文件中各处引用的文件、资料、包括所要用到的系统开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。序号文档名称版本/日期备注12第2章系统说明2.1系统用途提示:叙述该项项目开发的意图、应用目标、作用范围以及其他应向读者说明的有关该项目开发的背景材料。解释被系统与其他相关系统之间的关系。如果本系统产品是独立的,而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框

4、图来说明该系统的组成和本产品同其他各部分的联系和接口。2.2程序（功能)说明提示:说明系统中每一程序（功能)、分程序(功能）的细节和特性 。2.3安全保密提示：说明系统中各种角色(帐户）的保密方面的设计和考虑，各种系统角色(帐户）的层级关系和管理范围、保密设定、管理规范等等。第3章系统运行环境3.1系统架构提示：说明系统采用的软硬件架构,系统模块间的相互连接关系等,图表的形式描述系统采用的协议、信令、标准等。3.2系统硬件和网络环境提示：图表形式说明系统采用的硬件平台、设备等,图表说明系统运行的网络环境，运行平台等。如需与其他系统对接,说明其他系统之间的关系，可能涉及的共同协议等。3.3系统运

5、行平台提示:表格形式说明系统当中的系统运行环境需求，对用户使用的影响，支撑系统正常运行的平台需求。3.4系统界面描述提示:图形方式清晰描述按照业务需求的主要界面的各种元器件分布。3.5接口提示：与其他系统间或多个系统间的,接口物理特性、软件和硬件接口，以及涉及的通讯协议。第4章程序1的说明4.1程序1的描述提示：给出程序1 的概要描述。4.2程序1的方法提示：详细说明本程序的实现方法。或者用列表的方式(例如IP表即输入、处理、输出表的形式),逐项定量和定性地叙述本程序模块所提出的功能要求，说明系统应支持的终端数和应支持的并行操作的用户数。4.2.1输入4.2.2输出 4.2.3表格提示:说明程

6、序内部的各种表、项的细节和特性。4.2.4数据库特性提示:表格形式描述本程序1的数据字典设计范例。序号数据库表、视图名字段名和类型备注字段1类型字段2类型字段3类型12序号存储过程,包等逻辑代码或结构备注124.2.5对非功能的需求 4.2.6系统参数及系统精度提示:说明系统内部可能需要的参数和相互间系统的参数传递。说明对该系统的输入、输出数据精度的要求，包括可能的传输过程中的精度。系统间数据互换的精度。4.2.7灵活性说明对该系统的灵活性的要求,即当需求发生某些变化时,该系统对这些变化的适应能力,如:操作方式上的变化；运行环境的变化；同其他项目系统的接口的变化;精度和有效时限的变化；计划的变

7、化或改进。对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。4.2.8时间管理特性提示：需用甘特图表示系统设计大概进度要求和功能模块间的关系。纵轴是功能及子功能。横轴是时间。系统页面响应时间:更新处理的时间：数据提交的时间：各个事物的响应时间4.2.9输入输出要求提示：解释各输入输出数据类型,并逐项说明其媒体、格式、数值范围、精度等。对系统的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告(正常结果输出、状态输出及异常输出)以及图形或显示报告的描述。4.3故障处理要求提示：列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。4.4其他非功能需求提示：如用户单位对安全保密的要求,对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。第5章程序2的说明提示：本章为可选项,如果本系统由多个子程序组成，则需分开多章编写，编写规范按照上一章内容编写。