1 引言
1.1 编写目的:阐明编写手册的目的并指明读者对象。
1.2 项目背景:说明项目的提出者、开发者、用户和使用场所。
1.3 定义:列出报告中所用到的专门术语的定义和缩写词的原意。
1.4 参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,及保密级别,可包括:用户操作手册;与本项目有关的其他文档。
2 系统说明
2.1 系统用途:说明系统具备的功能,输入和输出。
2.2 安全保密:说明系统安全保密方面的考虑。
2.3 总体说明:说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。
2.4 程序说明:说明系统中每一程序、分程序的细节和特性。
2.4.1 程序1的说明
● 功能:说明程序的功能。
● 方法:说明实现方法。
● 输入:说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。
● 处理:处理特点和目的,如:用图表说明程序的运行的逻辑流程;程序主要转移条件;对程序的约束条件;程序结束时的出口要求;与下一个程序的通信与联结(运行、控制);由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元;程序运行存储量、类型及存储位置等。
● 输出:程序的输出。
● 接口:本程序与本系统其他部分的接口。
●表格:说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括:表的标识符;使用目的;使用此表的其他程序;逻辑划分,如块或部,不包括表项;表的基本结构;设计安排,包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。
● 特有的运行性质:说明在用户操作手册中没有提到的运行性质。
2.4.2程序2的说明
与程序1的说明相同。以后的其他各程序的说明相同。
3 操作环境
3.1 设备:逐项说明系统的设备配置及其特性。
3.2 支持软件:列出系统使用的支持软件,包括它们的名称和版本号。
3.3 数据库:说明每个数据库的性质和内容,包括安全考虑。
3.3.1总体特征:如标识符、使用这些数据库的程序、静态数据、动态数据;数据库的存储媒体;程序使用数据库的限制。
3.3.2结构及详细说明
● 说明该数据库的结构,包括其中的记录和项。
● 说明记录的组成,包括首部或控制段、记录体。
● 说明每个记录结构的字段,包括:标记或标号、字段的字符长度和位数、该字段的允许值范围。
● 扩充:说明为记录追加字段的规定。
4 维护过程
4.1 约定:列出该软件系统设计中所使用全部规则和约定,包括:程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则;图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;使用的软件技术标准;标准化的数据元素及其特征。
4.2 验证过程:说明一个程序段修改后,对其进行验证的要求和过程(包括测试程序和数据)及程序周期性验证的过程。
4.3 出错及纠正方法:列出出错状态及其纠正方法。
4.4 专门维护过程:说明文档其他地方没有提到的专门维护过程。如:维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;运行程序库维护系统所必需的要求、过程和验证方法;对闰年、世纪变更的所需要的临时性修改等。
4.5 专用维护程序:列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:维护作业的输入输出要求;输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。
4.6 程序清单和流程图:引用或提供附录给出程序清单和流程图。
分享到:
相关推荐
软件维护总复习提纲整理出了许多考试要点,希望对大家有帮助。
软件测试复习提纲
SIMATIC 过程控制系统 PCS 7 提纲 D 部分 - 操作和维护[手册]pdf,
清华大学版软件工程复习提纲 什么是软件需求? 用户对目标系统在功能、行为、性能等方面的要求 什么是需求分析? 对软件需求的理解、分析与表达 需求工程的六个阶段是什么? 需求获取、需求分析与协商、系统建模、...
华南理工大学软件工程复习提纲
软件项目开发的全套文档提纲,介绍软件开机流程
电影票预订系统的访谈提纲及数据库分析
系统维护复习提纲 基本概念 基本方法和技能
软件开发项目文档提纲参考
计算机软件工程专业毕业论文提纲示例 基于ASP技术的人才招聘信息系统 1 前 言 2 项目背景 2.1 开发背景 2.2 动态网页技术的发展和前景分析 2.2.1常见动态网页技术ASP、JSP、PHP与ASP.NET 2.2.2发展趋势与...
观致5 SUV车主手册教学提纲.pdf观致5 SUV车主手册教学提纲.pdf观致5 SUV车主手册教学提纲.pdf观致5 SUV车主手册教学提纲.pdf观致5 SUV车主手册教学提纲.pdf观致5 SUV车主手册教学提纲.pdf
软件工程 复习提纲
质量手册编写提纲.pdf
软件设计提纲与管理信息系统
软件工程复习提纲.pdf软件工程复习提纲.pdf软件工程复习提纲.pdf软件工程复习提纲.pdf软件工程复习提纲.pdf
08级——软件架构考试提纲.pdf08级——软件架构考试提纲.pdf08级——软件架构考试提纲.pdf08级——软件架构考试提纲.pdf08级——软件架构考试提纲.pdf08级——软件架构考试提纲.pdf
华工 软件工程 复习提纲