软件设计规格说明书样例

1、 项目名称：xx系统软件设计规格说明书document number 文档编号 confidentiality level 密级 worksoft-doa-002内部公开document version 文档版本 total pages 共48 页v1.0 xx design specificationxx系统软件设计说明书prepared by 拟制xxdate日期2007-9-20reviewed by 评审人date日期yyyy-mm-ddapproved by批准date日期yyyy-mm-ddrevision record 修订记录date日期revision version修订版本

2、sec no. 修改章节change description修改描述author作者2007-9-201.0文档创建樊伟table of contents 目录sony cpsg doa design specification sony cpsg doa系统1软件设计说明书11doa系统简介51.1文档编写目的51.2文档编写背景51.3文档适用范围61.3.1软件名称61.3.2软件功能61.3.3软件应用61.4术语和缩略语62doa系统总体架构设计描述72.1软件系统上下文定义72.1.1总体架构图72.1.2系统架构图描述82.1.3doa系统组件图82.1.4doa系统组件描述92

3、.1.5系统部署图102.1.6doa系统其他特点102.1.7doa系统功能菜单图122.1.8doa系统功能菜单图描述133doa系统功能设计描述133.1设备注册描述133.1.1设备注册页面类关系调用图133.1.2用户注册描述143.1.3类详细描述153.2设备接收描述163.2.1设备接收页面类关系调用图163.2.2设备接收类描述173.2.3类详细描述183.3doa进口设备委托检测流程描述213.3.1类关系调用图213.3.2ccf流程描述213.3.3类详细描述223.4doa设备维修处理描述223.4.1类关系调用图233.4.2doa设备维修处理描述233.4.3类

4、详细描述253.5出库单、取货单管理描述273.5.1类关系调用图273.5.2出库单、取货单管理描述283.5.3类详细描述293.6系统信息维护303.6.1类关系调用图303.6.2系统信息流程313.6.3类详细描述324数据库设计334.1数据库关系图334.2数据据库表结构344.3数据库代码枚举465组件视图485.1系统运行组件485.2文件组织形式486参考文献486.1软件需求规格说明书486.2微软dowamish 7.0系统架构486.3微软详细设计规格说明书样例487附录481 doa系统简介1.1 文档编写目的本文档目的为有效的管理sony（中国）有限公司（简称so

5、ny）中国专业系统集团（简称为cpsg）doa设备，为此我们设计并开发了sony cpsg doa management system（简称：doa系统），来帮助sony相关人员的日常工作并提高工作效率，有效的跟踪doa设备状态。编写本软设计说明书是为了软件开发者开发doa系统的总体依据，方便开发人员。本文档的定义描述doa系统的物理设计、逻辑设计。描述doa系统架构设计，使系统物理层次清晰。描述doa系统业务逻辑，避免开发人员产生业务逻辑分歧。采用面向对象的设计思想，描述doa系统所有的类设计和类属性方法设计。覆盖软件所有的功能点。覆盖主要的用户体验。与其他文档关系以软件需求说明书为基础。是

6、除软件需求说明书外其它文档编写的基础文档。doa系统物理逻辑变更，业务逻辑变更需变更本文档后在改变其他文档和软件编码。文档后续修改必须填写修改记录。系统修改必须修改此软件说明书。1.2 文档编写背景本软件设计说明书是在doa需求说明书基础上编写的，所有关于doa设备的检测和修理，doa设备进出库的管理、设备的状态查询、报表生成，以及设备信息维护和信息提醒的用户，也适用于本系统的设计人员和开发人员。本软件需求说明书涵盖了doa系统所有的功能设计，可用性需求，可靠性需求，性能需求，可支持性，设计约束，购买的构件，接口，安全保密，法律、版权等的详细描述。本软件需求说明书将作为软件设计的基础。1.3

7、文档适用范围开发doa系统的相关人员阅读。1.3.1 软件名称本系统英文名称：sony cpsg dead-on-arrival system本系统英文简称：doa system本系统中文名称：sony doa 管理系统1.3.2 软件功能参见软件需求规格说明书1.3.3 软件应用参见软件需求规格说明书1.4 术语和缩略语u doa：sony cpsg dead-on-arrival systemu cpsg：sony（中国）专业系统集团u instec：负责sony专业设备的维修和检测u ccsg：负责sony民用产品的维修和检测u r/n：doa return delivery note

8、取货单u d/n：doa delivery note 出库单u doa form：doa处理单u ccf：check commission form 委托检测单u b2b：sony 销售和市场部的一个部门（负责一类设备）u 8d，6d：sony设备的分类标识。u qc group：sony 仓库的一个新部门。u sony库位描述：info:bj: n001; sh: e001; gz: s0010100 (a-stock)0200 (b-stock)0300 (crash)0400 (damaged)0500 (repair)0800 (demo)2 doa系统总体架构设计描述2.1 软件系统

9、上下文定义2.1.1 总体架构图图一 系统整体架构图图示说明：双向箭头表示层之间调用的关系。2.1.2 系统架构图描述ad server活动目录：提供系统的用户信息，系统中的用户名和密码从ad中提取。ad用户登陆验证。它提供公共接口和doa系统交互。ui层（presentation tier）:提供系统的外部操作界面。是用户直接体验并操作系统的层面。以a web form 页面为组成部分，用户界面，用户自定义控件，系统配置文件，系统图片。ie浏览器为浏览程序。业务逻辑层（business tier）：构造doa系统核心业务逻辑对象模型，实现doa系统业务逻辑。它将doa系统复杂的业务数据和操作

10、转换成一套易于理解的对象体系。数据访问层（data access tier）：封装访问数据库的组件，实现和数据库的交互。底层数据库（sql server tier）：实现doa数据关系，存储doa系统数据。支撑层（support tier）：封装doa系统公共函数，系统配置信息，数据库联接信息层类。可以被doa系统其它层调用。实体层（model tier）：封装doa系统数据实体。数据库每一个表在此层都有一个实体类。实体类的作用是在doa系统各个层间进行数据传输。所有的实体 类都继承dataset。自动发邮件模块（im thread）：系统定期发送邮件系统。2.1.3 doa系统组件图图二 系

11、统组件图2.1.4 doa系统组件描述用户登陆验证组件：封装ad服务器和doa系统交互接口、封装用户信息数据操作业务逻辑，权限管理组件：封装用户操作、用户角色操作、用户部门操作、访问权限控制和用户附权操作。设备管理组件：封装doa设备注册，修改，删除等业务逻辑。单据管理组件：封装设备出库单、设备取货单、委托检测单、doa处理单、业务逻辑。出/入库操作组件：封装设备出入库操作业务逻辑。条码扫描和打印：封装设备条码扫描和打印处理。审批管理组件：封装审批权限，审批印章管理。信息维护组件：封装系统信息业务逻辑组件。邮件管理：封装e-mail提示信息业务逻辑。支撑组件：封装数据处理和系统配置信息公共函数

12、组件。2.1.5 系统部署图系统的部署需要web服务器、数据库服务器、ad服务器、邮件服务器。用户端通过http协议访问web服务器。web服务器通过http协议访问ad服务器，通过ado.net访问数据库服务器，通过smtp协议访问邮件服务器。用户端以usb/串口形式与扫描仪通讯，从扫描仪上上传或下载信息，得到信息后上传到服务器。用户端与扫描仪通讯的数据格式是xml用户端以usb/串口访问打印机。2.1.6 doa系统其他特点doa系统采用面向对象的系统分析方法和原则。提高了系统的清晰性、安全性和重用性。根据目前微软主流的体系架构（参考dowamish7体系结构）doa系统在纵向上采用五层体

13、系结构：ui层、业务逻辑层、数据访问层、支撑层、实体层和sql server数据库层。参见图一系统架构图。根据微软.net2005类型化的dataset数据封装技术，doa系统的实体类数据集采用dataset来实现系统各个层面的数据传输。图四 系统消息图doa系统在横向上将业务逻辑封装在对象中。通过对象和对象之间的调用来实现业务流程。 图五 对象调用模型图2.1.7 doa系统功能菜单图 图三 doa系统功能菜单图2.1.8 doa系统功能菜单图描述doa系统菜单是根据功能点来划分，不同的功能点有不同的菜单。（参见doa系统设计原形）3 doa系统功能设计描述3.1 设备注册描述3.1.1 设

14、备注册页面类关系调用图3.1.2 用户注册描述l 当用户填写机器注册信息时,点击”查询ew信息”时会调用机器注册类(registermachine_doamachineform)中的函数getdeclarinfo,会根据所填写的”型号”和”机身号”自动获得经销商的 “经销商id”和”经销商的名称”以及”最终客户”字段的信息.l 用户在填写机器注册信息过程中,点击”图片信息”按钮,则会跳转到图片上传页面,当用户在图片上传页面点击上传图片,则会调用图片类(registermachine_doauploadimage)中的函数uploadfile(上传图片到服务器)与saveimage(上传图片到数

15、据库).用户点击”删除图片”时,应用程序会调用(registermachine_doauploadimage)中的函数deletefile(删除服务器上图片)和函数filedeletedatabase (删除数据库图片信息)l 当用户填写完基本信息点击添加附件时,此时会调用(registermachine_doamachineform) 中的函数savemessage先保存用户所填的基本信息,然后再跳转到附件页面.在用户选选择完附件后,点击确定.这时会调用附件类(registermachine_adoaccessoriesform)中函数insertaccessories保存附件信息.3.1.

16、3 类详细描述页面继承基类（pagebase）方法描述函数名称返回类型输入参数极其类型功能描述savemessagevoid保存注册设备信息modifyinfomationvoid修改注册设备信息deleteinfovoid删除注册设备信息deleteaccessoriesvoid删除附件信息insertaccessoriesvoid插入附件信息uploadfilestring上传图片到服务器saveimagebool上传图片到数据库deletefilebool删除服务器上图片filedeletedatabasevoid删除数据库图片insertaccessoriesvoid 添加附件getn

17、extmachinecodestring获取新的doa codegetnewnoteidstring获取新的单据编号getnewuniquenostring获得附件唯一编号getmanageidint获得用户mgr id属性描述属性属性类型属性状态属性描述modelname设备型号machinesn机身号eightbitcode8dcreateuserid单据创建用户idcreatetime单据创建时间doaformno单据idprocessstate设备状态vendornum经销商编号vendorname经销商名称enduser最终客户imageid图片idimageurl图片路径3.2 设

18、备接收描述3.2.1 设备接收页面类关系调用图3.2.2 设备接收类描述l 当用户填写检测结果,点击”确定”时,应用程序则会调用填写检测结果类doaformprocess_doaformcheckresultlist 中的函数checkresultl 用户填写技术处理建议,点击”确定”.应用程序则会调用填写技术处理建议类中的proadvice函数.l 当用户在处理技术处理建议审批,点击”通过”时,应用程序会调用技术处理建议审批类中的auditingpass函数,点击”拒绝”时,则会调用auditingrefuse函数l 当用户处理设备处理意见审核,点击”紧急审批时”,应用程序则会调用设备处理意

19、见审核类中函数decidepro_btnurgent_click. 点击”销售pic审批”则会调用此类中decidepro_btnsalespic_click 函数,点击” 销售经理审批”则调用此类中decidepro_btnsalesmgr_click函数.点击”拒绝”,则会根据相关的权限分别调用urgentrefuse函数, salespicrefuse函数和salesmgrrefuse函数.l 用户在接收设备确认时,点击确认,则会调用doa设备接收确认类中的machinereceive函数.3.2.3 类详细描述页面继承基类（pagebase）方法描述函数名称返回类型输入参数极其类型功能

20、描述checkresult检测结果proadvice填写技术处理建议auditingpass技术处理建议审批通过auditingrefuse技术处理建议审批拒绝decidepro_btnurgent_click设备处理意见审核紧急审批通过decidepro_btnsalespic_click销售pic意见审核通过decidepro_btnsalesmgr_click销售经理意见审核通过urgentrefuse设备处理意见审核紧急审批拒绝salespicrefuse销售pic意见审核拒绝salesmgrrefuse销售经理意见审核拒绝machinereceive设备接收确认machinedest

21、ination送修目的地updatestate送修目的地(批处理方法)属性描述属性属性类型属性状态属性描述checkuserid检测结果用户idchecktime检测结果时间faultdescription检测结果描述adviseuserid技术处理建议用户idadvisetime技术处理建议时间solutiondescription技术处理建议意见approveuserid技术处理建议审批用户idapprovetime技术处理建议审批时间approvestate技术处理建议审批状态urgentengtime设备处理意见审核紧急审批时间urgentenguserid设备处理意见审核紧急审批用户

22、idurgentengapprovestate设备处理意见审核紧急审批状态normalpicuseridsales审批用户normalpictimesales审批时间normalpicapprovestatesales审批状态normalmgrapprovestatesales经理审批状态normalmgruseridsales经理审批用户normalmgrtimesales经理审批时间receivesignuseridreceivesigntimesendrepairlocationid选择送修地点sendrepairlocationuserid送修地点选择人sendrepairlocati

23、ontime送修地点选择时间4 数据库设计4.1 数据库关系图4.2 数据据库表结构table nametable descriptioncolumn typelencolumn descriptionmaxid单据id表maxtypenvarchar50类型typedatenvarchar50单据类型maxidint10单据最大idmemonvarchar128备注doaformdoa处理单doaformidint10doaformnonvarchar18doa处理单idcreateuseridint10创建人idcreatetimedatetime23创建时间doaformstateint

24、10doa单据状态planprocess技术确认planprocessidint10machineidint10idsolutiondescriptionnvarchar512技术部处理建议adviseuseridint10建议人advisetimedatetime23建议时间approvetimedatetime23经理审批时间approvestateint10经理审批状态approveuseridint10审批经理isurgentchar1是否紧急allocatetimedatetime23分配审批时间conclusiontypeint10处理意见（是否换机）conclusionother

25、nvarchar32处理意见（其他）urgentenguseridint10eng审批用户urgentengtimedatetime23eng审批时间urgentengapprovestateint10eng审批状态normalpicuseridint10sales审批用户normalpictimedatetime23sales审批时间normalpicapprovestateint10sales审批状态normalmgrapprovestateint10sales经理审批状态normalmgruseridint10sales经理审批用户normalmgrtimedatetime23sales

26、经理审批时间changetypeint10换机类型changeoptuseridint10换机操作人changeopttimedatetime23换机操作时间sendrepairlocationidint10选择送修地点sendrepairlocationuseridint10送修地点选择人sendrepairlocationtimedatetime23送修地点选择时间accmachine附件主机关联表accessorymachineidint10uniquenonvarchar18唯一编码createtimedatetime23创建时间imageurlnvarchar128图片路径carto

27、nsnnvarchar18包装箱机身号machinesnnvarchar18设备机身号memonvarchar512备注binnonvarchar18库位号plantnonvarchar18货位号accessoryidint10附件idmachineidint10设备idservicecenter服务中心servicecenteridint10codenvarchar32代码namenvarchar32名称englishnamenvarchar32英文名称memonvarchar512备注cityidint10城市idaddressnvarchar128地址contactmannvarchar

28、32联系人telephonenvarchar32电话locationnvarchar128位置modifytimedatetime23修改时间modifyuseridint10修改人bitcode6d/8d关系表bitcodeidint10eightbitcodenvarchar328dsixbitcodenvarchar326dcontactmannvarchar32联系人checkprocess检测表checkprocessidint10machineidint10设备idcartonfaulttypenvarchar8包装箱状态machinefaulttypenvarchar8设备状态f

29、aultdescriptionnvarchar512检测结果（故障问题描述）chechfeedecimal10检测费用isrepairchar1是否修理ischangecartonchar1是否换箱checkuseridint10检测人checktimedatetime23检测时间cartons包装箱维护cartonidint10namenvarchar32包装箱名称englishnamenvarchar32英文名称weightfloat53重量lengthfloat53长度heightfloat53高度colornvarchar16颜色memonvarchar512备注widthfloat5

30、3宽度ccfccf单据checkcommissionformidint10checkcommissionformnonvarchar18委托检测单单号stateint10ccf单据状态repaircenteridint10维修中心idmemonvarchar512备注warehouseidint10仓库idcreateuseridint10创建用户createtimedatetime23创建时间city城市cityidint10citynamenvarchar32城市名称englishcitynamechar18城市名称（英文）zonenvarchar32区域memonvarchar512备注

31、customers客户信息customeridint10companynamenvarchar128客户名称contactnamenvarchar32客户公司名称addressnvarchar128地址postcodenvarchar12邮编contacttitlenvarchar32联系人titlemobilenvarchar32手机citynamenvarchar32城市名称regionnvarchar32区域countrynvarchar32城市phonenvarchar32电话faxnvarchar32传真modifyuseridint10修改人idmodifytimedatetime

32、23修改时间customernumnvarchar32备用字段dapertments部门信息dapertmentidint10部门idnamenvarchar32部门名称englishnamechar18英文名称telephonenvarchar32部门电话descriptionchar18描述cartonprocess包装箱处理cartonprocessidint10machineidint10设备idcartonsnnvarchar18包装箱机身号categorytypenvarchar8换箱类型changeuseridint10换箱类型决定人changetimedatetime23换箱类

33、型决定时间changeapprovestateint10换箱审批状态changeapproveuseridint10换箱审批人changeapprovetimedatetime23换箱审批时间cartonidint10包装箱idfunctionrole功能角色对应表functionidint10权限idroleidint10角色idsystemmaxid系统idtablenamechar30表名serialint10当前最大数量executeprocess设备维修确认表executeprocessint10machineidint10设备iddecisiontypenvarchar8最终处理意

34、见（是否修理）decisionfeedecimal10费用decisionmemonvarchar512备注decideuseridint10处理意见决定人decidetimedatetime23处理意见决定时间initialprocess设备相关人员表initialprocessidint10initialprocess设备相关人员表initialprocessidint10machineidint10设备idsolutionadviseuseridint10选择销售的操作人engmgridint10eng经理idsalesuseridint10相关销售salesmgruseridint10

35、相关销售经理goodsissuetom发货设备关系表machineidint10goodsissueidint10发货单idimageinfo图片信息表imageidint10图片idimageurlnvarchar100存储路径receivegoodsis收货信息表receivegoodsissueidint10receivegoodsnonvarchar18取货单iddeliverycompanynvarchar128发货单位deliveryaddressnvarchar128发货地址deliverernamenvarchar32发货人名称deliverertelephonenvarcha

36、r32发货人电话deliverermobilenvarchar32发货人手机receiptorfaxnvarchar32接收人传真receivecompanynvarchar128接收公司receiveaddressnvarchar128接收地址receiptornamenvarchar32接收人名字receiptortelephonenvarchar32接收人电话receiptormobilenvarchar32接收人手机receivetimedatetime23接收时间transporternvarchar128承运人shiptopartynvarchar18卸货地址warehouseid

37、int10仓库idplantnonvarchar18货位号binnonvarchar18库位号routenvarchar18运输方式remarksnvarchar32备注vehiclenonvarchar18车辆号deliverysignnvarchar32发货签章receiptesignnvarchar32接收签章shipsignnvarchar32到货签字createuseridint10创建人idcreatetimedatetime23创建时间modifyuseridint10修改人idmodifytimedatetime23修改时间storagelocationidint10货物存储位

38、置shippingpointidint10到货地点receivegoodsstateint10单据状态deliveryfaxnvarchar32发货传真deliverytimedatetime23发货时间systemtype系统代码表typeidint10typenamenvarchar32代码类型名称itemidint10唯一iditemcodenvarchar32codeitemnamenvarchar32唯一id描述itemnameennvarchar32唯一id描述（英文）parentitemcodenvarchar128父codelogs日志logidint10lognamenvar

39、char32登陆名称logtimedatetime23登录时间functionidint10功能iduseridint10用户idmodels型号表modelidint10型号idnamenvarchar32型号名称englishnamenvarchar32型号名称（英文）heightfloat53高度memonvarchar512备注widthfloat53宽度lengthfloat53长度weightfloat53重量eightbitcodenvarchar188dsixbitcodenvarchar186dquoteprocess维修报价表quoteprocessidint10machi

40、neidint10设备idhardwarefeedecimal10零件费techinefeedecimal10技术费quoteuseridint10报价人quotetimedatetime23报价审批quoteapprovestateint10sc审批维修费用状态quoteapproveuseridint10sc审批维修费用用户quoteapprovetimedatetime23sc审批维修费用时间purchasefeedecimal10设备采购价格sellingfeedecimal10设备销售价格negotiateuseridint10填写设备相关费用用户negotiatetimedatet

41、ime23填写设备相关费用时间negotiateapprovestateint10eng审核维修费用状态negotiateapproveuseridint10eng审核维修费用用户negotiateapprovetimedatetime23eng审核维修费用时间warehouses仓库表warehouseidint10codenvarchar32仓库编码warehousenamevarchar20仓库名称englishwarehousenamechar18仓库英文名称cityidint10城市iddescriptionnvarchar512描述modifyuseridint10修改人modif

42、ytimedatetime23修改时间addressnvarchar128地址contactmannvarchar32联系人telephonenvarchar32电话receiveprocess接收确认表receiveprocessidint10machineidint10设备idconfirmtypenvarchar8审核类型ishavenewfaultchar1是否有新故障newfaultdescriptionnvarchar512新故障描述receivesignuseridint10接收人idreceivesigntimedatetime23接收时间sendsignuseridint10

43、发送idsendsigntimedatetime23发送时间receivegoodsis收货设备关系表machineidint10设备idreceiveissueidint10收货单idrepaircenter维修中心repaircenteridint10codenvarchar32维修中心编码namenvarchar32维修中心名称englishnamenvarchar32维修中心英文名称memonvarchar512备注cityidint10城市idaddressnvarchar128地址contactmannvarchar32联系人telephonenvarchar32电话locationnvarchar128位置mo