软件维护手册
主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。
1引言
1.1编写目的
阐明编写手册的目的并指明读者对象。
1.2项目背景
说明项目的提出者、开发者、用户和使用场所。
1.3定义
列出报告中所用到的专门术语的定义和缩写词的原意。
1.4参考资料
列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,及保密级别,可包括:用户操作手册;与本项目有关的其他文档。
2系统说明
2.1系统用途
说明系统具备的功能,输入和输出。
2.2安全保密
说明系统安全保密方面的考虑。
2.3总体说明
说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。
2.4程序说明
说明系统中每一程序、分程序的细节和特性。
2.4.1程序1的说明
● 功能:说明程序的功能。
● 方法:说明实现方法。
● 输入:说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。
● 处理:处理特点和目的,如:用图表说明程序的运行的逻辑流程;程序主要转移条件;对程序的约束条件;程序结束时的出口要求;与下一个程序的通信与联结(运行、控制);由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元;程序运行存储量、类型及存储位置等。
● 输出:程序的输出。