软件详细设计报告文档
- 格式:docx
- 大小:186.41 KB
- 文档页数:13
家庭个人理财软件详细设计报告1、引言1.1编写目的在前一阶段(概要设计)中,已解决了实现该系统需求的程序模块设计问题。
包括系统模块间的关系设计,以及数据结构和模块结构的设计等。
在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。
本阶段依据概要设计的要求,确定应该如何具体地实现所要求的系统,从而在编码阶段可以把这个描述直接翻译成用具体的程序语言书写的程序。
具体包括各功能模块信息的录入、修改和删除,以及对数据库信息的统计分析等。
1.2定义1.3参考资料1.需求分析报告2.概要设计报告2、总体设计2.1需求概要用户在登录系统后,可以根据自己的需要对自己的日常财务活动进行管理。
系统提供用户管理日常财务活动的功能模块,凭借这些模块,用户可以实现对理财信息的数据的录入、删除和修改,以及进行文件打印和导出。
系统必须有效、准确地帮助用户处理财务信息,并通过图形和列表的形式帮助用户分析数据;另外,系统操作应较为简单,易于维护,从而满足用户的使用需求。
2.2软件各模块结构各模块间的关系在概要设计里已经给出。
1、投资管理模块:股票&& 买入卖出投资管理基金&& 申购赎回债券&& 买入卖出2、银行账户管理模块:添加删除修改银行账户管理账户转账收支详情打印导出BuyStock_Click ( )SellStock_Click( ) BuyFund_Click( ) SellFund_Click( )BuyBond_Click( ) SellBond_Click( )InsertBAccount_Click( ) DeleteBAccount_Click( ) UpdateBAccount_Click( )TransferBAccount_Click( )Print_Click( )Educe_Click( )BAccountDetail_Click( )3、证券账户管理模块:添加删除证券账户管理修改资金转账转账详情4、收支管理模块:添加收入删除修改收支管理打印添加支出删除导出修改InsertSAccount_Click( ) DeleteSAccount_Click( )UpdateSAccount_Click( )TransferSAccount_Click( ) TransferDetail_Click( )InsertIncomeData_Click( ) DeleteData_Click( )UpdateIncomeData_Click( )InsertExpenseData_Click( ) DeleteData_Click( )UpdateExpendData_Click( ) PrintOut_Click( ) EduceOut_Click( )。
学生信息管理系统详细设计报告题目专业: 班级:小组成员:指导教师: 职称:2010年12 月徐州题目详细设计说明书作者:日期:目录1.算法描述 (4)1.1 请假 (4)1.1.1 程序流程图 (4)1.1.2 函数说明 (4)1.2 查询 (6)1.2.1 程序流程图 (6)1.2.2 函数说明 (6)1.3 找老乡 (8)1.3.1 程序流程图 (8)1.3.2 函数说明 (8)1.4登录 (10)1.4.1程序流程图 (10)1.4.2函数说明 (10)1.5注册 (11)1.5.1程序流程图 (11)1.5.2函数说明 (11)2.数据组织 (12)3.界面设计 (12)3.1设计分析 (12)3.2正常状态 (12)3.3异常状态 (13)1.算法描述1.1 请假1.1.1 程序流程图1.1.2 函数说明hM_input()功能包含:首先创建一个请假信息数据结构hMassage1再提示输入请假信息: 输入结构为请假信息数据结构hMassage ExitMg1()功能包含:输出:假期开始日期填写格式有误, 请重新再来一次ExitMg2()功能说明:输出:假期终止日期填写格式有误, 请重新再来一次ExitMg3()功能说明:输出:请假理由填写格式有误, 请重新再来一次Hm_secess()功能说明:输出: 请假条填写成功按任意键继续Fix_hMassage(hMassage)功能说明:审查请假起始日期与请假终止日期是否在法定假日内Change_hM()功能说明:修改hMassage中的QJJG为1, 即允许请假, 并输出:请假成功Teacher_set_hM()功能说明:由辅导员设置QJJG的值相应输出请假结果1.2 查询1.2.1 程序流程图1.2.2 函数说明makeChoise()是用户按输出提示选择功能编号: 1.学号方式查询2.姓名方式查询….input_Massage()接受用户的输入Fix_Information()参数为: 用户的查询方式检查其格式的正确性search()对数据库进行查找, 并记录符合条件的学生信息nosearch()输出未找到相应的学生out_Display()将所有符合的学生信息输出1.3 找老乡1.3.1 程序流程图1.3.2 函数说明Compare1()功能包含:首先创建一个找老乡籍贯信息数据结构再提示输入籍贯信息: 输入message1Exit1()功能包含:输出:籍贯格式有误, 请重新再来一次Compare2()功能包含:首先创建一个籍贯信息集合输入籍贯信息比较: 输入message2Exit2()功能说明:输出:籍贯信息不匹配, 请重新再来一次Sf_insert()功能说明: 正确输入Select()功能说明: 根据输入籍贯信息搜索信息Reason()功能说明: 查询失败, 可能输入条件逻辑有误或没有信息Resoult功能说明: 显示结果1.4登录1.4.1程序流程图1.4.2函数说明Login()功能说明:提示输入ID和密码Password()功能说明:函数参数: 学号验证学号对应的密码Display()函数说明:输出功能选择1.信息查找2、请假申请3、老乡查询并提示输入选择的的功能号1.5注册1.5.1程序流程图1.5.2函数说明Login_syste()功能说明: 登入系统Put_information()功能说明: 填入信息Check_infomation功能说明: 核对一些必要的信息有没有填写Make_out information()功能说明: 信息填写成功2.数据组织数据组织形式见需求分析的数据字典部分。
软件工程详细设计文档模板一、引言在软件开发过程中,详细设计文档扮演着至关重要的角色。
它是一份说明软件系统如何实现的文档,对于开发团队的沟通、代码的编写以及后期维护都起到了重要的指导作用。
本文档旨在提供一个软件工程详细设计文档的模板,以便开发团队在编写详细设计文档时可以有一个统一的参考。
二、概述本章节主要对软件系统的整体架构进行描述,包括系统的主要功能、设计目标、运行环境以及涉及的技术栈等。
三、系统架构该章节应该对软件系统的整体架构进行详细介绍,包括系统的主要模块及其功能、模块之间的交互关系等。
同时,可以使用一些图表来形象地表示系统的架构。
四、模块设计在这个章节,应对系统中的每一个模块进行详细的设计说明,包括模块的输入、输出、功能、算法、数据结构等。
可使用流程图或者类图来对模块的设计进行表示。
五、数据库设计如果软件系统中涉及到数据库,此章节应对数据库的设计进行详细描述。
包括数据库的表结构、字段设计、关系建立等。
可以使用ER图或者数据库表结构图等形式来表示数据库的设计。
六、界面设计在这个章节,应对软件系统的界面设计进行详细说明。
包括界面的布局、颜色、字体等细节设计。
可以使用界面原型或者截图来表示系统的界面设计。
七、算法设计如果软件系统中涉及到一些复杂的算法,此章节应对这些算法进行详细的设计说明,包括算法的核心思想、输入输出以及具体实现代码等。
可以使用伪代码或者流程图来表示算法的设计。
八、安全设计在这个章节,应对软件系统的安全设计进行说明。
包括对数据安全的保护措施、用户权限管理、防止攻击等方面进行设计。
可以使用文字描述或者流程图来表示安全设计。
九、性能设计如果软件系统对性能有较高要求,此章节应对软件系统的性能设计进行详细说明。
包括对性能的预估、性能测试方案等方面进行设计。
可以使用文字描述或者性能测试报告来表示性能设计。
十、测试设计在这个章节,应对软件系统的测试设计进行详细说明。
包括测试方案的制定、测试用例的设计、测试环境的搭建等方面进行设计。
软件工程课程设计报告范文之详细设计报告范文详细设计说明书1、引言:1、1编写目的:在前一阶段(概要设计说明书)中,已解决了实现该系统需求的程序模块设计问题。
包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。
在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。
在本阶段中,确定应该如何具体地实现所要求的系统,从而在编码阶段可以把这个描述直接翻译成用具体的程序语言书写的程序。
主要的工作有:根据在《需求分析说明书》中所描述的数据、功能、运行、性能需求,并依照《概要设计说明书》所确定的处理流程、总体结构和模块外部设计,设计软件系统的结构设计、逐个模块的程序描述(包括各模块的功能、性能、输入、输出、算法、程序逻辑、接口等等)在以下的各个阶段中,《用户操作手册》将与本阶段的工作紧密结合,努力作到让用户易懂易学。
《测试报告》和《维护报告》也将参考本说明书,检验本系统的各项性能指标,及时发现纰漏及时修补,一定要把功能强大、稳定可靠、便于维护的机票预定系统交到用户手中。
1、2项目背景:在本即时聊天工具项目的前一阶段,也就是需求分析阶段,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对不同用户所提出的不同功能,实现的各种效果做了调研工作,并在需求规格说明书中得到详尽得叙述及阐明。
本飞Q即时聊天系统项目主要由两部分形成:1、客户端;2、数据库服务器端;21、3文中特殊的定义和缩写:1.3.1定义SQLSERVER:系统服务器所使用的数据库管理系统(DBMS)。
SQL:一种用于访问查询数据库的语言事务流:数据进入模块后可能有多种路径进行处理。
主键:数据库表中的关键域。
值互不相同。
外部主键:数据库表中与其他表主键关联的域。
ROLLBACK:数据库的错误恢复机制。
1.3.2缩写系统:若未特别指出,统指本机票预定系统。
SQL:StructuredQueryLanguage(结构化查询语言)。
软件设计报告一、引言在当今数字化时代,软件已经成为了各行各业不可或缺的一部分。
从智能手机应用到企业管理系统,软件的应用范围越来越广泛。
而软件的设计过程,是将需求转化为可执行代码的关键环节。
本报告将详细介绍一个软件设计的案例,并探讨其中的方法和技术。
二、需求分析在软件设计之前,首先要明确用户的需求。
这需要通过与用户的交流,收集并整理相关信息。
本案例的软件设计是一个在线购物平台,主要需求包括浏览商品、添加到购物车、下单支付等功能。
通过需求分析,我们得到了系统的功能和性能要求。
三、概要设计概要设计是在需求分析的基础上,确定软件的整体结构和功能模块。
在本案例中,我们将采用三层架构来设计软件系统。
数据层负责处理数据库的增删改查,业务逻辑层负责实现具体的业务功能,表示层负责用户界面的展示和用户交互。
通过这种分层的结构设计,可以降低各模块之间的耦合度,提高系统的可维护性。
四、详细设计详细设计是在概要设计的基础上,进一步明确每个功能模块的实现细节。
在本案例中,我们将详细设计涉及到的功能模块分别进行设计和实现。
其中,浏览商品功能包括商品列表展示和商品详情展示,添加到购物车功能包括添加商品和修改商品数量等。
通过详细设计,我们可以更加清晰地了解每个功能的实现逻辑,有利于后续的编码和测试工作。
五、编码与测试编码是将设计文档中的内容转化为实际代码的过程。
在本案例中,我们将采用面向对象的编码方式,使用Java语言来实现软件系统。
同时,为了保证软件的质量和可靠性,我们还需要进行相关的测试工作。
测试包括单元测试、集成测试和系统测试等。
通过不同层次的测试,可以发现和解决潜在的问题,确保软件的功能和性能符合需求。
六、部署与维护软件的部署与维护是软件生命周期的最后一个阶段。
在部署阶段,我们需要将编码和测试完成的软件系统部署到目标环境中,并进行系统的配置和参数设置。
而在维护阶段,我们需要不断对软件进行更新和优化,以满足用户的新需求和提升系统的性能。
软件开发中心Software Development Center 详细设计说明书项目名称<项目名称>文档类别<文档类别>文档编号<文档编号>版本<V1.0>密级<秘密>二〇二一年三月十五日版本修订记录目录1引言1.1.编写目的{简要说明编写这份详细设计说明书的目的,指出预期的读者。
本详细设计说明书的编写目的是为了说明程序系统的各个层次中的每个软件对象(包括每个模块和程序)的设计考虑,以向系统实现(编码和测试)阶段提供关于程序系统实现方式的详细描述,从而成为编码的技术基础。
本详细设计说明书的适用读者为:软件开发者、测试人员}1.2.项目概况{1.说明待开发的软件系统的名称2.列出本项目的任务委托单位、开发单位、协作单位、用户单位3.说明项目背景,叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
如果本次开发的软件系统是一个更大的系统的一个组成部分,则要说明该更大系统的组成和介绍本系统与其它相关系统的关系和接口部分4.保密说明:本项为可选项,一般的软件公司都会要求对软件开发的概要设计文档进行保密,不允许被复制、使用和扩散到公司之外的范围,如果需要强调则允许做相关的保密说明5.版权说明:本项为可选项,若有必要,才要作有关的描述。
}1.3.术语定义{列出本文档中所引用到的专门术语的定义和首字母缩写词、缩略语的原文,以便对详细设计说明书进行适当的解释}1.4.参考资料{列出所本文档所使用的参考资料,包括:A 本软件开发所经核准的合同或标书或可行性报告等文档B 软件开发计划书C 需求分析报告D 测试方案(若存在初稿的话)E 概要设计说明书F 与本项目有关的已发表的文件或资料G 本文件中各处引用的文件、资料,所采用的软件开发标准和规范注意:必须列出文件、资料的作者、标题、编号、发表日期和出版单位,以说明这些文件资料的来源。
软件工程设计报告(例子)软件工程设计报告(例子)1. 引言本文档旨在描述一个虚构的软件工程项目的设计过程和结果。
该项目是一个在线购物平台的设计,包括前端和后端开发。
本报告将涵盖项目需求分析、概要设计、详细设计以及测试计划。
2. 项目背景购物平台是当今流行的电子商务应用之一,为消费者提供了方便快捷的购物体验。
为了开发一个具有竞争力的购物平台,我们决定设计一个用户友好、稳定可靠的系统。
3. 需求分析在需求分析阶段,我们与客户合作,确定了以下功能和需求:- 用户注册和登录- 商品展示和搜索- 购物车管理- 订单管理- 支付和物流跟踪在需求分析的基础上,我们创建了用例模型和活动图,以帮助我们更好地理解用户的需求和系统的功能。
4. 概要设计在概要设计阶段,我们首先考虑了整体系统结构和组件之间的关系。
我们决定使用MVC(模型-视图-控制器)架构来实现系统。
以下是系统的概要设计:- 前端:使用、CSS和JavaScript开发用户界面- 后端:使用Python编程语言开发后端逻辑- 数据库:使用MySQL来存储用户数据和商品信息我们还创建了系统的类图和时序图,以明确各个组件之间的交互和数据流。
5. 详细设计在详细设计阶段,我们对系统的每个模块进行了更详细的设计。
以下是系统的详细设计:- 用户管理模块:包括用户注册、登录和个人资料管理功能。
我们设计了相应的数据库表和API接口。
- 商品管理模块:包括商品展示、搜索和分类功能。
我们设计了相应的数据库表和API接口。
- 购物车模块:包括添加商品、删除商品和结算功能。
我们设计了相应的数据库表和API接口。
- 订单管理模块:包括订单、确认订单和取消订单功能。
我们设计了相应的数据库表和API接口。
- 支付和物流模块:我们与第三方支付和物流服务提供商集成,以实现在线支付和物流跟踪功能。
详细设计阶段还包括数据库设计、API设计和界面设计等方面。
我们使用UML工具和原型设计工具来辅助设计工作。
软件设计报告一、引言。
软件设计是软件开发过程中至关重要的一环,它直接影响着软件的质量和性能。
本报告将对我们团队所设计的软件进行详细的介绍和分析,包括软件的功能特点、设计思路、技术方案等内容。
二、需求分析。
在进行软件设计之前,我们首先对软件的需求进行了详细的分析。
根据用户的需求和市场的需求,我们确定了软件的功能模块,包括用户管理、数据管理、界面设计等方面。
同时,我们也对软件的性能和安全性进行了充分的考虑,确保软件能够稳定运行并保护用户的数据安全。
三、设计思路。
在软件设计过程中,我们遵循了模块化和可扩展性的设计思路。
通过将软件拆分为多个独立的模块,我们能够更好地进行开发和维护。
同时,我们也考虑了软件的可扩展性,确保软件能够在未来进行功能的扩展和升级。
四、技术方案。
在选择技术方案时,我们充分考虑了软件的性能和稳定性。
我们采用了先进的开发工具和技术,包括数据库技术、前端技术和后端技术等。
通过合理的技术选择,我们能够更好地满足软件的需求,并提升软件的用户体验。
五、测试与优化。
在软件设计完成后,我们进行了充分的测试和优化工作。
通过各种测试手段,我们发现并修复了软件中的各种问题和bug,确保软件能够稳定运行。
同时,我们也对软件的性能进行了优化,提升了软件的运行速度和响应能力。
六、总结。
通过本次软件设计,我们团队不仅提升了对软件开发过程的理解和把握,同时也为用户提供了一款功能完善、性能稳定的软件产品。
我们将继续努力,不断提升软件的质量和用户体验,为用户提供更好的软件产品。
七、致谢。
在软件设计的过程中,我们得到了许多人的支持和帮助,在此表示衷心的感谢。
同时也感谢用户对我们软件的信任和支持,我们将不负众望,为用户提供更好的服务。
以上就是本次软件设计报告的全部内容,谢谢阅读!。
软件工程设计报告(例子)软件工程设计报告(例子)1. 引言软件工程设计报告是对软件项目进行详细设计的文档。
本报告将介绍一个虚构的软件项目的设计过程,以提供一个示例来说明软件工程设计的步骤和方法。
2. 背景本项目是一个在线图书商城系统,旨在为用户提供方便快捷的图书购买和阅读体验。
用户可以通过该系统浏览图书、下订单、进行支付和阅读等操作。
3. 需求分析在开始设计前,我们进行了需求分析阶段的工作。
通过与用户进行交流和讨论,我们明确了以下关键需求:用户注册和登录图书浏览和搜索下订单和支付在线阅读4. 架构设计在架构设计阶段,我们选择了采用三层架构来实现系统功能。
这包括以下三个层次:表示层:负责与用户交互,展示图书信息、处理用户输入业务逻辑层:负责处理用户请求,进行订单处理和支付等操作数据访问层:负责与数据库交互,包括用户信息、图书信息和订单信息的存取5. 数据库设计为了支持系统的功能,我们设计了以下几个数据库表:用户表:用于存储用户信息,包括用户名、密码和等图书表:用于存储图书信息,包括书名、作者、价格和库存等订单表:用于存储订单信息,包括订单号、用户ID、图书ID 和订单状态等6. 模块设计系统的模块设计包括以下几个关键模块:用户管理模块:负责用户的注册、登录和信息修改等功能图书管理模块:负责图书的浏览、搜索和详情展示等功能订单管理模块:负责订单的、支付和状态处理等功能阅读管理模块:负责在线阅读功能的实现7. 接口设计为了实现系统的各个模块间的通信,我们设计了以下几个接口:用户接口:包括用户注册、登录和信息修改等接口图书接口:包括图书浏览、搜索和详情展示等接口订单接口:包括订单、支付和状态处理等接口阅读接口:包括图书在线阅读和翻页等接口8.通过本报告,我们详细介绍了一个在线图书商城系统的软件工程设计过程。
从需求分析到架构设计、数据库设计、模块设计和接口设计,我们展示了软件工程设计的主要步骤和方法。
希望这个示例能够对读者理解软件工程设计的过程有所帮助。
软件详细设计报告文档模板1. 引言....................................................1.1编写目的 .................................................................................................................................1.2项目风险 .................................................................................................................................1.3文档约定 .................................................................................................................................1.4预期读者和阅读建议 .............................................................................................................1.5参考资料 .................................................................................................................................2. 支撑环境...............................................2.1数据库管理系统 .....................................................................................................................2.2开发工具、中间件以及数据库接口 .....................................................................................2.3硬件环境 .................................................................................................................................2.4网络环境 .................................................................................................................................2.5多种支撑环境开发要点 .........................................................................................................3. 部件详细设计...........................................4. 词汇表.................................................5. 部件表格式.............................................6. 界面表格式.............................................1. 引言引言是对这份软件系统详细设计报告的概览,是为了帮助阅读者了解这份文档如何编写的,并且应该如何阅读、理解和解释这份文档。
软件详细设计报告文档 Document serial number【UU89WT-UU98YT-UU8CB-UUUT-UUT108】
软件详细设计报告文档模板
1. 引言
引言是对这份软件系统详细设计报告的概览,是为了帮助阅读者了解这份文档如何编写的,并且应该如何阅读、理解和解释这份文档。
1.1 编写目的
说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的,开发这个软件产品意义、作用、以及最终要达到的意图。
通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构,从而对该软件产品的物理组成进行准确的描述。
如果这份软件系统详细设计报告只与整个系统的某一部分有关系,那么只定义软件系统详细设计报告中说明的那个部分或子系统。
1.2 项目风险
具体说明本软件开发项目的全部风险承担者,以及各自在本阶段所需要承担的主要风险,首要风险承担者包括:
●任务提出者;
●软件开发者;
●产品使用者。
1.3 文档约定
描述编写文档时所采用的标准(如果有标准的话),或者各种编写约定。
编写约定应该包括:
●部件编号方式;
●界面编号方式;
●命名规范:
●等等。
1.4 预期读者和阅读建议
列举本软件系统详细设计报告所针对的各种不同的预期读者,例如,可能的读者包括:
●开发人员;
●项目经理;
●测试人员;
●文档编写人员;
●等等。
描述文档中,其余部分的内容及其组织结构,并且针对每一类读者提出最适合的文档阅读建议。
1.5 参考资料
列举编写软件系统详细设计报告时所用到的参考文献及资料,可能包括:
●本项目的合同书;
●上级机关有关本项目的批文;
●本项目已经批准的计划任务书;
●用户界面风格指导;
●开发本项目时所要用到的标难;
●系统规格需求说明;
●使用实例文档;
●属于本项目的其它己发表文件;
●本软件系统详细设计报告中所引用的文件、资料;
●相关软件系统详细设计报告;
●等等。
为了方便读者查阅,所有参考资料应该按一定顺序排列。
如果可能,每份资料都应该给出:
●标题名称;
●作者或者合同签约者;
●文件编号或者版本号;
●发表日期或者签约日期;
●出版单位或者资料来源。
2. 支撑环境
2.1 数据库管理系统
描述数据库管理系统、以及安装配置情况,需要描述的内容可能包括:
●产品名称以及发行厂商
这里的产品名称指的是数据库发行厂商发布产品时公布的正式商品名称,不应该
使用别名、简称、研发代号等非正式名称,以免混淆;同样的道理,发行厂商的
名称也应该使用正式名称。
●版本号
数据库管理系统的准确版本号,必须按产品的实际情况描述到最细节的版本号。
●补丁包版本号
描述实际上将要使用的数据库管理系统补丁包的版本号,必须注意,在某些情况
下该版本号不一定是最新的版本号。
●语言或代码集
对于只支持一种语言或者一个代码集的数据库管理系统来说,该项描
述不具意
义。
对于支持多种语言或者多个代码集的数据库管理系统来说,该项描述指的是
实际使用的语言或者代码集。
●安装位置
描述数据库管理系统的实际安装位置,应该分别对管理系统安缺位置和数据存放
位置进行描述,应该指明服务器名和安装卷号(盘号)。
对于分布式数据库,必须
分别描述每一个数据库管理系统。
●配置参数
描述数据库管理系统在实际安装时应该配置的各个参数,对于分布式数据库,必
须分别描述每一个数据库管理系统的配置参数。
●等等
同时参照《南京市交通局信息化数据库建设规范》。
2.2 开发工具、中间件以及数据库接口
描述所选用的工具软件和中间件的名称、版本号,以及开发工具与数据库或者中间件接口的情况。
如果使用了多种开发工具、辅助开发工具、第三方软件部件、多种中间件、多种接口、等答应该逐项分别描述,并且说明每一项的适用范围。
需要描述的内容可能包括:
●产品名称以及发行厂商
同中产品名称以及发行厂商。
●版本号
同中版本号。
●补丁包版本号
同中补丁包版本号。
●语言或代码集
同中语言或代码集。
●数据库接口名称
描述数据库接口的名称,如果使用别名时,应同时描述使用的别名。
●数据库接口方式
描述与数据库接口的方式,并说明该接口方式的特点;如果需要,还应该说明使
用时的注意事项。
●数据库接口设置
描述各种接口设置,包括:协议、端口号等等。
同时参照《南京市交通局信息化数据库建设规范》。
2.3 硬件环境
描述所选用的硬件环境,各种机型,例如:服务器、工作站,应该分别描述。
需要描述的内容可能包括:
●机型;
●主频;
●内存容量;
●磁盘容量;
●特殊部件;
●操作系统;
●使用位置;
●等等。
2.4 网络环境
描述可能影响应用软件访问数据库的各种网络环境,如果存在加密传输、VPN链路等情况,也必须描述。
对于结构复杂的网络,还应该提供网络拓扑图和数据流向示意图。
需要描述的内容可能包括:
●网络结构;
●网络操作系统;
●网络带宽;
●路由组织;
●加密传输方式;
●VPN链路连接方式;
●等等。
2.5 多种支撑环境开发要点
当软件产品将来可能遇到的多种运行环境时,应该分别按照节至节的内容列表描述。
如果软件产品各个子系统的运行环境不完全一样时,应该分子系统按照节至节的内容列表描述。
遇到上述情况时,不仅需要详细描述各种软件开发、调试、测试的环境,为了确实保证软件产品将来能够在各种可能的运行环境中正常运行,还需要对软件产品进行严格的配置管理。
3. 部件详细设计
这里所提及的软件部件,系指能够完成特定功能、相对独立的一些代码集合,它们可以是插件、组件、控件、函数、过程、子程序、动态连接库、等等。
具体呈何种形态,取决于实际采用的开发工具和将要实现的软件结构。
按照合适的顺序,逐个描述软件部件的详细情况。
描述的顺序可以是按层次横向进行描述,也可以是按模块纵向进行描述,总之描述的方式必须有利于读者理解软件结构。
每个部件采用一张软件部件表进行描述,软件部件表的格式见附表一,其中;
●部件编号
软件部件的统一顺序编号;对于实行配置管理的软件开发项目来说,该编号必须
与该部件在配置管理中的编号相同。
●部件名称
软件部件的正式英文名称,该名称是程序中使用的实际名称,必须符合国家相关软件命名标准。
●所属子系统
指该部件所属的子系统;
对于不分为多个子系统的软件来说,不必填写该栏。
●部件调用者
指调用该部件的部件(或界面参数)的编号和名称。
●部件被调用者
指被该部件所调用的部件的编号和名称。
●部件入口参数
指该部件入口数据类名称或者数据名称,以及对这些数据的描述;
如果部件没有入口参数,该栏为空。
●部件出口参数
指该部件出口数据类名称或者数据名称,以及对这些数据的描述;
如果部件没有出口参数,该栏为空。
●算法
指该部件的算法形式表示,如果很简单、或者不存在,也可以为空。
●流程描述
指该部件的处理流程的详细表示或描述。
●部件表示形式
指该部件完成开发后的最终表示形式,具体形式取决于开发工具和软件结构,表
示形式可能是:
插件、组件、控件,
函数、过程、子程序,
存储过程,
动态连接库,
等等。
●运行环境
描述该部件所适合的运行环境,即说明该部件是针对何种运行环境所开发的;
可以直接描述运行环境,也可以描述运行环境的编号;
对于实行配置管理的软件开发项目来说,该描述必须与该部件在配置管理中的描
相同。
●性能要求
指开发该部件时必须满足的专门要求,这些要求可以是:
精度
灵活性
响应时间
可重用性
等等。
提出的要求一般不宜超过3项,以排列的先后顺序表示优先级。
4. 词汇表
列出本文件中用到的专业术语的定义,以及有关缩写的定义(如有可能,列出相关的外文原词)。
为了便于非软件专业或者非计算机专业人士也能够在一定的范围内,读懂软件系统详细设计报告,要求尽可能使用非软件专业或者非计算机专业的术语进行描述。
所以这里所指的专业术语,是指业务层面上的专业术语,而
不是软件专业或者计算机专业的术语。
但是,对于无法回避的软件专业或者计算机专业术语,也应该列入词汇表,并且加以准确定义。
5. 部件表格式
说明:如果软件不见使用一张表表述不完时,可以采用续表描述,但是必须注明是那张表的续表。
6. 界面表格式
说明:如果软件不见使用一张表表述不完时,可以采用续表描述,但是必须注明是那张表的续表。