程序维护手册范例解析doc资料Word文档下载推荐.docx

1、鉴于以上各点, 编写维护软件的文档十分重要。 它给软件维护人员提供了一份完整, 清 晰的说明文档,便于其快速有效地进行维护工作。开发单位项目的提出者:开发者:用户:使用场所:定义和缩写a. 数据流图 描绘系统的逻辑模型,图中没有任何具体的物理元素,只是描绘信息在系 统中流动和处理的情况,它表示了数据和处理过程的关系。数据流图有四种基本符号:正 方形（或立方体表示数据的源点或终点。圆 角矩形（或圆形代表变换数据的处理。处理不一定是一个程序。一个处理框可以代表一系列程序,单个程序或者程序的 一个模块;它甚至可以代表一种人工处理过程。开 口矩形（或两条平行横线代表数据存储。数据存储可以表示一个文件,

2、文件的一部分,数据库的元素或纪录的一部分等等。 数据存储是处于静止状态的数据。箭 头代表数据流,即特定数据的流动方向。数据流是处于运动中的数据。还有几种附加符号:星 号表示数据流之间是“与”关系加 号表示“或”关系异 或符号表示只能从中选一个b. 数据字典 （Data Dictionary, 简称 DD 是对系统中各类数据描述的集合, 是各类数据属 性清单, 是进行详细的数据收集和数据分析所获得的主要结果。 它通常包括以下五个部 分:数 据项,是数据的最小的单位。数 据结构,是若干数据项有意义的集合。数 据流,可以是数据项,也可以是数据结构,表示某一处理过程的输入或输出。 数 据存储,处理过程

3、中存取的数据。常常是手工凭证,手工文档,计算机文件。 处 理过程。它们的描述内容如下:1.数据项描述 =数据项名,数据项含义说明,别名,类型,长度,取值范围,与其他 数据项的逻辑关系 取值范围,与其他数据项的逻辑关系定义了数据的完整性约束条件,是设计数据检 验功能的依据。2.数据结构描述 =数据结构名,含义说明,组成:数据结构或数据项 3.数据流 =数据流名,说明,流出过程,流入过程,组成:数据结构或数据项 流出过程,说明该数据流由什么过程来。流入过程,说明该数据流到什么过程去。4.数据存储 =数据存储名,说明,输入数据流 ,输出数据流,组成:数据结构或数 据项 ,数据量,存取方式 数据量,说

4、明每次存取多少数据,每天（或每小时,或每周存取几次的信息。 存取方法,指的是批处理,还是联机处理;是检索还是更新;是顺序检索还是 随机检索;尽可能详细收集并加以说明。5.处理过程 =处理过程名,说明,输入:数据流 ,输出:数据流 ,处理:简要说 明 简要说明中主要说明该处理过程的功能,即“做什么” （不是怎么做 ;处理频度要 求,如每小时（或每分钟处理多少事务,多少数据量;响应时间要求等。这些处理要 求是后面物理设计的输入及性能评价的标准。d. 主键 :数据库表中的关键域。值互不相同。e. 外部主键 :数据库表中与其他表主键关联的域。f. 系统 :若未特别指出,统指本机票预定系统。g. SQL

5、 : Structured Query Language（结构化查询语言 , 一种用于访问查询数据库的语言h. SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS 。i. ATM : Asynchronous Transfer Mode （异步传输模式 。j. ROLLBACK : 数据库的错误恢复机制。参考资料书籍:软件工程导论第三版 张海藩 清华大学出版社 实用软件工程第二版 郑人杰 殷人昆 陶永雷 清华大学出版社 文档:需求规格说明书,概要设计说明书,详细设计说明书,用户操作手册。2. 系统说明系统用途输入:输出:功能:安全保密系统提供一定的方式让用户表示自己的身份,系统

6、进行核实,通过鉴定后才提供 机器使用权。常用的方法有:1.用一个用户名或用户标识号来标识用户身份。2.口令。3.系统提供一个随机数,用户根据预先约定好的某一过程或者函数进行计算,系 统根据用户计算结果是否正确进一步鉴定用户身份。系统管理员还可对获得上机权的用户进行权限控制, 是不同的用户对于不同的数据对象 有不同的操作权限。总体说明系统的总体功能:系统接收输入的预定机票的旅客信息, 为旅客安排航班, 印出取票通 知和帐单, 旅客在飞机起飞的前一天凭取票通知和帐单交款取票, 系统校对无误即印出机票 给旅客。系统的具体功能:1. 接 受:旅客信息及取票通知和帐单;2. 打 印:取票通知和帐单及机票

7、;3. 网 络输出和加密,输入和解密;4. 分 辨信息的种类并采取相应的处理步骤;5. 判 断信息的正误并采取相应的处理步骤;6. 进 行数据库的查询、修改工作;7. 接 受并判断错误,输出相应的出错消息;程序说明1. PersInfoExam 过程:对 在 旅 客 信 息 界 面 中 输 入 的 各 项 信 息 进 行 初 步 检 验 。 若 发 现 错 误 , 令 ErrorAppear=T,判断错误类型,并将相应的 错误类型 ErrorType 或 ErrorRank 作为参数,转 入 ErrorHandle 过程。若未发现错误,转入 PersInfoInput 过程。其中的错误种类有:

8、1. 数据类型不匹配 ,ErrorType =T;姓名 string 旅行目的地 string性别 string 旅行时间 date工作单位 string （年 /月 /日 yy/mm/dd身份证号码 long int2、数据超出规定范围 ErrorRank =T;等等性别只能是男或女 ;身份证号码按规定必须是 13位;旅行时间必须在 定票的当天过一天以后等等2、 PersInfoInput 过程:经检验无误后,将输入界面表单中的数据输入到 Class PersInfoClass PersInfo /* 伪码 */String name=姓名 ;String sex= 性别;String co

9、mpany= 工作单位;Long int idcode= 身份证号码;Date stime= 旅行时间;（syear/smonth/stime=年 /月 /日String denist= 目的地2.操作环境设备共享一个数据库的若干台电脑,台式打印机若干。支持软件支持常用的数据库应用软件:VISUAL FOXPRO 5.0 , DELPHI 4.0, POWER BUILDER 6.0数据库标识符:姓名,性别,工作单位,身份证号码,旅行时间,旅行目的地。静态数据:存储在硬盘上的数据。动态数据:正处于处理过程中的数据。数据库的存储媒体:硬盘。3. 维护过程规则1.设计原则1. 密切结合结构（数据设

10、计和行为（处理设计。2.有机结合硬件,软件,技术和管理的界面。3.具体程序实现过程中,对记录,字段的引用参照 PersInfo 类。4.存储区的标识符也参照 PersInfo 类。5.在设计过程中参照瀑布模型, ER 模型,层次图, Jackson 程序设计方法。 2.设计程序变更的准则1. 检 查可供选择的设计方案,寻找一种与程序的原始设计原理相容的变更设计。2. 努 力使设计简化。3. 能 满足可变性要求的设计。4. 不 降低程序质量。5. 用 可测试的并具备测试方法的术语描述设计。6. 考 虑处理时间,存储量和操作过程方面的变化。7. 考 虑标更对用户服务的干扰以及实施变更的代价与时间。

11、3.修改程序代码的准则1. 必 须要先熟悉整个程序的控制流程。2. 不 要做不必要的修改。3. 不 影响原始程序的风格和相容性。4. 记 录所作过的修改。5. 审 查软件质量是否符合标准。6. 更 新程序文档以反映修改并保留修改前的程序代码版本。4.重新验证程序的准则1. 首 先测试程序故障,然后测试程序的未改动部分,最后测试程序的修改部分。2. 不 允许做修改的维护程序员成为唯一的重新验证程序的人。3. 鼓 励终端用户参与到重新测试进程中来。4. 在 重新验证进程中, 记录出错的次数与类型, 并把结果同所提供的测试功能进行 比较,以便估量出程序是否退化。验证过程每当软件被修改后,都要校验其正

12、确性。维护员应该有选择地作些重新测试工作, 不仅要证实新的逻辑的正确性, 而且要校验实程序的为修改部分是否无损害, 并且整个 程序运行正确。若发现错误,则要马上进行修正。出错及纠正方法经查询还有余票, 但输入旅客信息后却发现已没有余票。 发生这种情况的原因是:有多 台计算机同时输入订购同一次航班的旅客信息, 在查询余票时, 其他输入信息并未写入磁盘, 票数并未修改。此时,应该等待数秒后重新查询余票。专门维护过程系统运行一段时间后, 由于记录的不断增加, 删除和修改, 会使数据库的物理存储变坏。 例如,逻辑上属于同一记录型或同一关系的数据被分散到了不同的文件或文件的多个碎片 上。 这样就会降低数据库存储空间的利用率和数据的访存效率, 使数据库的性能下降。 这是 就要进行数据库的重组织。 在重组过程中, 按原设计要求重新安排记录的存储位置, 调整数 据区和溢出区,回收“垃圾” ,减少指针链等。程序清单及流程图详见概要设计和详细设计文档。