《软件说明书模板》由会员分享，可在线阅读，更多相关《软件说明书模板（20页珍藏版）》请在金锄头文库上搜索。
1、1、1编写目的： 31、2项目背景： 31、3文中特殊的定义和缩写： 4131定义 4132 缩写 41、4参考资料： 42.总体设计： 52、1需求概要： 52、2 软件结构： 51、客户机接受信息模块结构图： 52. 客户机输出信息模块： 63. 网络接受和发送模块结构： 74.服务器模块: 83、程序描述： 93、1 客户机接受信息模块： 91、PersInfoExam 过程： 92、PersInfoInput 过程： 93. PersInfoTempSave 过程： 104. CheckNoticeExam 过程:105. CheckNoticeInput 过程:106. CheckN
2、oticeSave 过程:117.IErrorHandle 过程:118.JudgeOrderOrCash 过程： 119.OrderTransPre 过程：1110. CashTranPre 过程： 1211.SetCSFlag过程:123.2客户机输出信息模块： 121. CDataRecPre 过程： 122. DBOperaCheck 过程： 123. JudgeOrderOrCheck过程： 124. PersInfoComp1 过程： 135. CheckNoticeOutput过程： 136CheckNoticeComp 过程： 137. PersInfoComp2过程： 138
3、. TicketOutput 过程： 139OErrorHandle 过程： 143.3网络接受和发送模块结构： 141. NetCheck过程： 142. RecPre过程： 143. NetReceive过程：144. NetDataDiscry过程： 155NetDataUnpack 过程： 156. SendPre 过程： 157. NetDataPack过程： 158. NetDataEncry过程： 159. NetSend过程： 1510. NetMonitor过程： 1511. NErrorHandle 过程： 1612. JudgeCSFlag 过程： 163.4服务器模块：
4、 161. SDataRecPre 过程:162. JudgeOrderOrCash 过程:163. TicketAvailable 过程:164. LockTicket 过程：165. AddPers 过程：176. GetoutCheck过程:177.InfoComp过程:178. GetoutTicket 过程： 179. DelItem 过程： 1710. JudgeCheckTicket 过程： 1811. CheckTransPre过程： 1812. TicketTransPre 过程： 1813.SetCSFlag 过程： 1814. DBErrorHandle 过程： 1815
5、. DBErrorTransPre 过程： 18五详细设计说明书1、 引言：1、1 编写目的：在前一阶段（概要设计说明书）中，已解决了实现该系统需求的程序模块设计 问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间 传递的信息，以及数据结构、模块结构的设计等。在以下的详细设计报告中将对在 本阶段中对系统所做的所有详细设计进行说明。在本阶段中，确定应该如何具体地实现所要求的系统，从而在编码阶段可以把这 个描述直接翻译成用具体的程序语言书写的程序。主要的工作有：根据在需求分 析说明书中所描述的数据、功能、运行、性能需求，并依照概要设计说明书 所确定的处理流程、总体结构和模块外
6、部设计，设计软件系统的结构设计、逐个模 块的程序描述（包括各模块的功能、性能、输入、输出、算法、程序逻辑、接口等 等），解决如何1接受：旅客信息及取票通知和帐单；2输出：取票通知和帐单及机票；3网络输出和加密，输入和解密；4分辨信息的种类并采取相应的处理步骤；5判断信息的正误并采取相应的处理步骤；6进行数据库的查询、修改工作；7接受并判断错误，输出相应的出错消息；在以下的各个阶段中，用户操作手册将与本阶段的工作紧密结合，努力作到 让用户易懂易学。测试报告和维护报告也将参考本说明书，检验本系统的各 项性能指标，及时发现纰漏及时修补，一定要把功能强大、稳定可靠、便于维护的机 票预定系统交到用户手中
7、。1、2项目背景：本项目（机票预定系统）时由浙江航空公司委托，由软件开发小组负责开 发。本 机票预定系统项目主要由两部分形成：1、各旅行社中的前台客户程序；2、航空公司中的数据库服务器程序；1、3文中特殊的定义和缩写：131定义SQL SERVER:系统服务器所使用的数据库管理系统（DBMS）。SQL: 一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。 主键：数据库表中的关键域。值互不相同。 外部主键：数据库表中与其他表主键关联的域。ROLLBACK: 数据库的错误恢复机制。132 缩写系统：若未特别指出，统指本机票预定系统。SQL: Structured Query
8、 Language （结构化查询语言）。ATM: Asynchronous Transfer Mode （异步传输模式）。1、4参考资料：浙江航空公司软件开发小组软件开发小组软件开发小组软件开发小组 天津科学技术出版社清华大学出版社Prentice Hall以下列出在概要设计过程中所使用到的有关资料：1 机票预定系统项目计划任务书2 机票预定系统项目开发计划3需求规格说明书4 概要设计说明书4用户操作手册（初稿）5 软件工程及其应用周苏、王文等6 软件工程张海藩7 Computer Network A.S.Tanenbaun文档所采用的标准是参照软件工程导论沈美明著的“计算机软件开发文档 编写
9、指南”。2.总体设计：2、1 需求概要：浙江航空公司为方便旅客，需开发一个机票预定系统。为便于旅客由旅行社代 替航空公司负责为旅客定票，旅行社把预定机票的旅客信息，包括姓名、性别、工 作单位、身份证号码、旅行时间、旅行目的地，输入机票预定系统的客户端程序， 系统经过查询航空公司内的航班数据服务器后，为旅客安排航班，印出取票通知。 旅客在飞机起飞前一天凭取票通知和帐单交款后取票，系统校对无误后即印出机票 给旅客。要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的 界面要单明了，易于操作，服务器程序利于维护。2、2 软件结构：各模块之间的关系已由概要设计给出。1、客户机接受信息模
10、块结构图怪旅客信息输入界面1帐单和通知输入界面2PersInfoExam ()CheckNoticeExam()PersInfoInput()IErrorHandle()CheckNoticeInput()PersInfoTempSave()JudgeOrderOrCash ()CheckNoticeTempSave()网络接受和发送模块2.客户机输出信息模块：网络接受和发送模块帐单和取票通知的输出界面1机票的输出界面23. 网络接受和发送模块结构：客户机接受信息模块或服务器输出信息模块NetDataDiscry ()NetReceive ()NetSend ()JudgeCSFlag ()N
11、etDataUnpack()NetDataEncry ()NetMo1NtOD(aJaPack()NErrorHandle()RecPre()NetCheck()SendPre()服务器输入信息模块客户机输出信息模块4.服务器模块:网络接受和发送模块网络接受和发送模块3、程序描述：3、1 客户机接受信息模块：1、PersInfoExam 过程:对在旅客信息界面中输入的各项信息进行初步检验。若发现错误，令PErrorAppear二T，判断错误类型，并将相应的 错误类型PErrorType或PErrorRank作为参数，转入 IErrorHandle过程。若未发现错误，转入Perslnfolnpu
12、t过程。其中的错误种类有：1.数据类型不匹配,PErrorType =T;否则=F;姓名string旅行目的地string性别string旅行时间date工作单位string（年/月/日yy/mm/dd)身份证号码long int定票/取票boolean2、数据超出规定范围PErrorRank =T;否则=F;等等 性别只能是男或女；身份证号码按规定必须是13位；旅行时间必须在定票的 当天过一天以后;等等2、PersInfoInput 过程：经检验无误后，将输入界面表单中的数据输入到Class PersInfo Class PersInfo/*伪码 */String name= 姓名 ；Str
13、ing sex= 性别；String company二工作单位；Long int idcode=身份证号码；Da te st ime=旅行时间；（syear/smo nt h/s ti me=年/月/日）String denis t=目的地 Boolocflag=定票/取票3PersInfoTempSave 过程：将由PersInfoInput输入的旅客信息保存在一个临时文件PersInfoTemp.txt中。以备与 将来从服务器经网络传输过来的数据校验。此类temp文件在每次软件的完全过程操作后，须 删除。4. CheckNoticeExam 过程:对在帐单和取票通知的信息界面中输入的各项信息进行初步检验。若发现错误，令CErrorAppear二T,判断错误类型，并将相应的 错误类型CErrorType或CErrorRank作 为参数，转入IErrorHandle过程。若未发现错误，转入CheckNoticelnput过程。其中的 错误种类有:1.数据结构不匹配,CerrorType=T,否则=F;帐单号 long int姓名 string身份证号码 long int付款金额 money航班号 string
