系统维护手册模板

ＸXXXXXX(建设单位)ＸXXＸXXXXＸXＸＸXXXＸX项目名称系统维护手册XＸX公司二〇年月文档修改统计版本号版本描述负责人日期备注V１.0初始编制XXXX20１版本号示例：Ｖ1．０、V2．０、V３.0、V4.0、V5.0……目录TOC\ｏ"1-3"\ｈ\z\ｕHYPERLINK＼l"＿Toｃ＂第一章 引言 PAGEREF＿Toc\h５HＹＰERLINK＼l"_Ｔoc"１.1 编写目的 ＰＡGEＲEF_Toc\h5HＹPＥRLIＮK1.2ﻩ文档范畴ﻩｈ5ＨYPERLINK1．3ﻩ项目概要ﻩPＡGEREF＿Tｏc\h５HYＰERLINK＼l"_Ｔｏc＂1.4ﻩ术语和缩写 PAＧEＲＥF_Toc\ｈ5HYPＥRLIＮK＼ｌ"＿Ｔoc"１．5 参考资料 PAGEＲEＦ_Ｔoc\ｈ5HYPEＲLIＮK\l＂_Toc＂第二章ﻩ系统阐明ﻩPAGEREＦ_Toｃ\h７HYPＥRLＩNK\ｌ"＿Toｃ＂2.1ﻩ系统用途 PAGERＥF_Toc\h7HYPＥRLIＮＫ\l＂_Toc"2.2ﻩ程序(功效)阐明ﻩPAGEREF＿Tｏc＼ｈ7HYPERLIＮＫ２.3 安全保密ﻩPAGEREF_Toｃ\h７HYＰERLＩNK第三章 系统运行环境ﻩPAGEＲEF_Ｔoc＼h8HYPＥRLINK\l"_Toc"3．1 系统架构 PＡGEREＦ_Ｔoc\h8HYPEＲLINK\l"_Toｃ＂3．2 系统硬件和网络环境ﻩPＡGＥREF_Toc\h８HYPEＲLINK\ｌ"＿Toc"3.3ﻩ系统运行平台 ＰAGＥREF_Ｔoc＼h８HYＰERLIＮＫ\l＂_Tｏc"3.4 系统界面描述ﻩPAGEＲEＦ_Ｔoc\h8_Toｃ＂第四章ﻩ程序1的阐明 PＡGEREF＿Toｃ\ｈ9HYＰＥRLIＮK４.1ﻩ程序1的描述ﻩPAＧＥREF_Ｔoｃ\ｈ9ＨYPERLINK\l"_Ｔｏc＂4.2 程序1的办法ﻩＰAGＥREF_Toc\h9HYPＥRLINK\l"_Ｔoc"4.2.1ﻩ输入ﻩＰAGEＲＥF_Toc＼ｈ９HＹPERＬINＫ4.2.2ﻩ输出 PAGEREF＿Toc\h9HYPERLINK\l＂＿Toc"4.2.3ﻩ表格ﻩPAGＥREF_Tｏc\h9ＨYPERLINK\l"_Toc"4．2．４ 数据库特性ﻩＰAGＥREF＿Tｏc＼h9HYPＥRLINK\l＂＿Toc"４.2.5 对非功效的需求 PAGEREF＿Tｏc\h10HYPＥＲLINK\l＂_Ｔｏc"4.2.6ﻩ系统参数及系统精度 PAＧERＥF_Toc＼ｈ１０HYPERLＩNK\l＂_Toｃ"4.２.7ﻩ灵活性ﻩ１0ＨYPＥRLINＫ＼l"_Toc"4.２.8ﻩ时间管理特性ﻩPAＧEREF＿Tｏc\ｈ10HYＰERLINＫ4.２.９ﻩ输入输出规定ﻩＰAＧＥＲEＦ_Ｔoc\ｈ1０ＨYＰERLIＮK4.3 故障解决规定ﻩPAGEＲEＦ_Toｃ\ｈ11HYPERＬINK＼l"_Ｔoc＂4．4ﻩ其它非功效需求ﻩPAGEREＦ＿Toc\h1１HYPERＬＩNＫ\l＂_Toc"第五章 程序２的阐明ﻩPAGＥREF_Ｔoc＼h1２引言编写目的提示：阐明编写这份系统维护手册的目的。本文档尽量以自然语言来描述，以期顾客和潜在读者能够快速理解,并方便与顾客进行沟通。文档范畴提示:需要描述清晰文档传输范畴和读者对象。项目概要提示:描述系统有关信息。待开发系统(或软件)的名称;本项目的任务提出者、开发者、顾客及实现该系统的部门或单位；该项目系统同其它系统或其它机构的基本的互相来往关系。术语和缩写提示:列出本文献中用到的专门术语的定义和外文首字母组词的原词组。序号术语名称术语定义1234….参考资料提示:列出用得着的参考资料，如:本项目的经核准的计划任务书或合同、上级机关的批文;属于本项目的其它已发表的文献;本文献中各处引用的文献、资料、涉及所要用到的系统开发原则。列出这些文献资料的标题、文献编号、发表日期和出版单位，阐明能够得到这些文献资料的来源。序号文档名称版本/日期备注12系统阐明系统用途提示:叙述该项项目开发的意图、应用目的、作用范畴以及其它应向读者阐明的有关该项目开发的背景材料。解释被系统与其它有关系统之间的关系。如果本系统产品是独立的,并且全部内容自含，则阐明这一点。如果所定义的产品是一种更大的系统的一种构成部分，则应阐明本产品与该系统中其它各构成部分之间的关系,为此可使用一张方框图来阐明该系统的构成和本产品同其它各部分的联系和接口。程序（功效)阐明提示:阐明系统中每一程序（功效)、分程序(功效）的细节和特性。安全保密提示：阐明系统中多个角色(帐户）的保密方面的设计和考虑，多个系统角色(帐户）的层级关系和管理范畴、保密设定、管理规范等等。系统运行环境系统架构提示：阐明系统采用的软硬件架构,系统模块间的互相连接关系等,图表的形式描述系统采用的合同、信令、原则等。系统硬件和网络环境提示：图表形式阐明系统采用的硬件平台、设备等,图表阐明系统运行的网络环境，运行平台等。如需与其它系统对接,阐明其它系统之间的关系，可能涉及的共同合同等。系统运行平台提示:表格形式阐明系统当中的系统运行环境需求，对顾客使用的影响，支撑系统正常运行的平台需求。系统界面描述提示:图形方式清晰描述按照业务需求的重要界面的多个元器件分布。接口提示：与其它系统间或多个系统间的,接口物理特性、软件和硬件接口，以及涉及的通讯合同。程序1的阐明程序1的描述提示：给出程序1的概要描述。程序1的办法提示：具体阐明本程序１的实现办法。或者用列表的方式(例如IPＯ表即输入、解决、输出表的形式),逐项定量和定性地叙述本程序模块所提出的功效规定，阐明系统应支持的终端数和应支持的并行操作的顾客数。输入输出表格提示:阐明程序内部的多个表、项的细节和特性。数据库特性提示:表格形式描述本程序1的数据字典设计范例。序号数据库表、视图名字段名和类型备注字段1类型字段2类型字段3类型12序号存储过程,包等逻辑代码或构造备注12对非功效的需求系统参数及系统精度提示:阐明系统内部可能需要的参数和互相间系统的参数传递。阐明对该系统的输入、输出数据精度的规定，涉及可能的传输过程中的精度。系统间数据交换的精度。灵活性阐明对该系统的灵活性的规定,即当需求发生某些变化时,该系统对这些变化的适应能力,如:操作方式上的变化；运行环境的变化；同其它项目系统的接口的变化;精度和有效时限的变化；计划的变化或改善。对于为了提供这些灵活性而进行的专门设计的部分应当加以标明。时间管理特性提示：需用甘特图表达系统设计大概进度规定和功效模块间的关系。纵轴是功效及子功效。横轴是时间。系统页面响应时间:更新解决的时间：数据提交的时间：各个事物的响应时间输入输出规定提示：解释各输入输出数据类型,并逐项阐明其媒体、格式、数值范畴、精度等。对系统的数据输出及必须标明的控制输出量进行解释并举例，涉及对硬拷贝报告(正常成果输出、状态输出及异常输出)以及图形或显示报告的描述。故障