您的位置  > 互联网

软件系统编写目的说明书编写方案概述

1 简介

1.1 写作目的

解释编写详细设计计划的主要目的。

编写指令的目的是为了说明软件系统各个层次的各个程序(各个模块或子程序)和数据库系统的设计考虑,为程序员编码提供依据。

如果一个软件系统比较简单,层数较少,则本文档不需要单独编写,而是可以与概要设计规范中不重叠的部分结合起来。

解决方案的重点是模块执行过程的描述和数据库系统的详细设计。

1.2 背景

应包括以下几个方面:

A、拟开发的软件系统名称;

B.系统的基本概念,如系统的类型、隶属地位等;

C. 开发项目团队名称。

1.3 参考文献

列出详细设计报告中引用的文件或资料,以及资料的作者、标题、出版单位和出版日期,必要时说明如何获取这些资料。

1.4 术语定义及解释

列出本文档中使用的可能引起混淆的术语、定义和缩写的原文。

2设计概述

2.1 使命和目标

解释详细设计的任务以及详细设计要达到的目标。

2.1.1 需求概述

对正在开发的软件进行简要描述,包括主要业务需求、输入、输出、主要功能、性能等,特别是系统性能要求。

2.1.2 运行环境概述

对本系统运行所依赖的硬件的描述,包括操作系统、数据库系统、中间件、接口软件、可能的性能监控和分析等软件环境以及配置要求。

2.1.3 条件和限制

详细说明系统所受的内部和外部条件的约束和限制的声明。 包括业务和技术条件和限制以及进度、管理等方面的限制。

2.1.4 详细设计方法和工具

简要描述详细设计所采用的方法和使用的工具。 如HIPO图法、IDEF(I2DEF)法、ER图、数据流图、业务流程图、精选CASE工具等。尽量使用标准规范和辅助工具。

3 系统详细需求分析

主要分析系统级需求。 首先,应进一步确认需求分析中提出的企业需求,并对因情况变化而导致的需求变化进行更详细的分析。

3.1 详细需求分析

包括:

详细的功能需求分析

详细的性能需求分析

详细的资源需求分析

详细的系统运行环境及限制分析

3.2 详细系统运行环境及限制分析接口需求分析

包括:

系统接口需求分析

现有软硬件资源接口需求分析

软硬件资源接口需求分析介绍

4 总体方案确认

重点解决系统整体结构确认和接口划分问题。

4.1 系统整体结构的确认

确认系统组成、逻辑结构和层次结构,确认应用系统、支撑系统及其各自的功能,细化集成设计和系统工作流程,特别关注系统本身的结构以及引入引起的公司其他系统的结构软件结构的变化。 包括:

Ÿ系统组成、逻辑结构及层次确认

Ÿ应用系统结构确认

Ÿ支撑体系结构确认

Ÿ系统集成确认

Ÿ系统工作流程确认

4.2 系统详细接口划分

4.2.1 应用系统和支撑系统接口详细划分

应用系统与支撑系统之间的接口包括系统主服务器和其他服务器的服务范围和访问方式、应用系统的网络和数据库支撑方式、全局数据的管理和访问方式等。

4.2.2 系统内部详细接口划分

系统各功能之间的接口包括覆盖范围、系统模块及模块间功能调用涉及的方法、全局数据格式、系统性能要求等。

5 系统详细设计

5.1 系统结构设计及子系统划分

设计前确认系统组成和逻辑结构。

划分系统功能模块或子系统(如果可用或必要,特别是对于大型软件系统)。

5.2 系统功能模块详细设计

根据结构化设计方法,系统的各个功能模块或子系统是在系统功能逐层分解的基础上进行设计的。 这是详细设计的主要部分之一。

用层次图来描述系统的整体结构、功能分解以及各模块之间的相互调用关系和信息交互。 用IPO图或者其他方式来描述各个模块完成的功能。 推荐使用HIPO图进行功能分解和模块描述。 对于更高的要求,建议使用IDEF0方法进行功能模型设计。

详细设计应用系统各组成模块所完成的功能及其相互关系。 使用IPO或结构图来描述组件结构、算法、模块之间的接口关系以及需求、功能和模块之间的关系。 交叉引用关系。

各模块的描述可以参考以下格式:

模块编号:

模块名称:

进入:

处理:

算法说明:

输出:

处理和算法描述部分主要使用伪代码或特定编程语言完成。

对于更详细的设计要求,建议使用IDEF0图来设计各个功能模块。

如果软件需要进行二次开发(包括功能扩展、功能修改、用户界面修改等),则应通过设置子主题来完成相应的设计工作。

5.3 系统界面详细设计

系统接口描述了应用系统软件的各种接口。 整个系统的其他接口(如系统硬件接口、通信接口等)在相应章节中进行描述。

5.3.1 外部接口设计

根据系统接口划分,设计系统的外部接口,设计系统的所有外部接口(包括功能接口和数据接口)。

5.3.2 内部接口设计

设计系统内部功能模块之间的调用关系和数据接口。

5.3.3 用户界面设计

规定了人机界面的内容、界面风格、调用方式等,包括用户要求的所谓表单设计、报表设计、打印输出等。 这一部分可能包含很多内容。

6.数据库系统设计

该数据库设计可以写入单独的卷中。 特别是对于大型数据库应用系统,有单独的《数据库设计说明》。

6.1 设计要求

6.2 信息模型设计

确定系统信息的类型(实体或视图),确定系统信息实体的属性、关键字和实体之间的联系,详细描述数据库和结构设计、数据元素和属性定义、数据关系模式、数据约束和限制。

6.3 数据库设计

6.3.1 设计依据

解释数据访问的频率和流量、最大数据存储容量、数据增长量、存储时间等数据库设计依据。

6.3.2 数据库类型及特点

解释系统中使用的数据库类型、各自的特点、数量、如何实现互连、如何传输数据。

6.3.3 数据库逻辑结构

讲解数据库概念模型到逻辑模型转换的方法和工具,完成数据库概念模型到逻辑模型的转换。 详细列出所使用的数据结构中各数据项、记录和文件的标识、定义、长度以及相互关系。 本节内容是数据库设计的主体部分。

6.3.4 物理结构设计

列出所使用的数据结构中每个数据项的存储要求、访问方式、访问单元和物理访问关系。 建立系统程序员的观点,包括:

Ÿ 数据在内存中的排列,包括索引区和缓冲区的设计;

Ÿ 使用的外部存储设备和外部存储空间的组织,包括索引区和数据块的组织和划分;

Ÿ如何访问数据。

6.3.5 数据库安全

解释数据如何共享以及如何确保数据安全性和机密性。

6.3.6 数据字典

编写详细的数据字典。 一般为数据库设计中涉及的各种项目,如数据项、记录、系统、卷模式、子模式等建立数据字典,以描述它们的标识符、同义词和相关信息。

7 信息编码设计

7.3 代码结构设计

确定总体信息分类编码方案,设计分类代码结构。

7.4 编码

根据代码结构编译信息代码