《软件设计规格说明书样例.doc》由会员分享，可在线阅读，更多相关《软件设计规格说明书样例.doc（36页珍藏版）》请在三一办公上搜索。
1、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修订版本Sec No. 修改章节Change
2、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.1.5系统部署图102.1.6DOA
3、系统其他特点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类详细描述253.5出库单、取货单管理描
4、述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（中国）有限公司（简称SONY）中国专业系统集团（简称为CPSG
5、）DOA设备，为此我们设计并开发了SONY CPSG DOA Management System（简称：DOA系统），来帮助SONY相关人员的日常工作并提高工作效率，有效的跟踪DOA设备状态。编写本软设计说明书是为了软件开发者开发DOA系统的总体依据，方便开发人员。本文档的定义描述DOA系统的物理设计、逻辑设计。描述DOA系统架构设计，使系统物理层次清晰。描述DOA系统业务逻辑，避免开发人员产生业务逻辑分歧。采用面向对象的设计思想，描述DOA系统所有的类设计和类属性方法设计。覆盖软件所有的功能点。覆盖主要的用户体验。与其他文档关系以软件需求说明书为基础。是除软件需求说明书外其它文档编写的基础文
6、档。DOA系统物理逻辑变更，业务逻辑变更需变更本文档后在改变其他文档和软件编码。文档后续修改必须填写修改记录。系统修改必须修改此软件说明书。1.2 文档编写背景本软件设计说明书是在DOA需求说明书基础上编写的，所有关于DOA设备的检测和修理，DOA设备进出库的管理、设备的状态查询、报表生成，以及设备信息维护和信息提醒的用户，也适用于本系统的设计人员和开发人员。本软件需求说明书涵盖了DOA系统所有的功能设计，可用性需求，可靠性需求，性能需求，可支持性，设计约束，购买的构件，接口，安全保密，法律、版权等的详细描述。本软件需求说明书将作为软件设计的基础。1.3 文档适用范围开发DOA系统的相关人员阅
7、读。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 取货单u D/N：DOA Delive
8、ry 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 软件系统上下文定义2.1.1 总体架构图图一
9、系统整体架构图图示说明：双向箭头表示层之间调用的关系。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系统组件图图二 系统组件图2.1.4 DOA系统组件描述
11、用户登陆验证组件：封装AD服务器和DOA系统交互接口、封装用户信息数据操作业务逻辑，权限管理组件：封装用户操作、用户角色操作、用户部门操作、访问权限控制和用户附权操作。设备管理组件：封装DOA设备注册，修改，删除等业务逻辑。单据管理组件：封装设备出库单、设备取货单、委托检测单、DOA处理单、业务逻辑。出/入库操作组件：封装设备出入库操作业务逻辑。条码扫描和打印：封装设备条码扫描和打印处理。审批管理组件：封装审批权限，审批印章管理。信息维护组件：封装系统信息业务逻辑组件。邮件管理：封装E-Mail提示信息业务逻辑。支撑组件：封装数据处理和系统配置信息公共函数组件。2.1.5 系统部署图系统的部署
12、需要Web服务器、数据库服务器、AD服务器、邮件服务器。用户端通过HTTP协议访问WEB服务器。WEB服务器通过HTTP协议访问AD服务器，通过ADO.NET访问数据库服务器，通过SMTP协议访问邮件服务器。用户端以USB/串口形式与扫描仪通讯，从扫描仪上上传或下载信息，得到信息后上传到服务器。用户端与扫描仪通讯的数据格式是XML用户端以USB/串口访问打印机。2.1.6 DOA系统其他特点DOA系统采用面向对象的系统分析方法和原则。提高了系统的清晰性、安全性和重用性。根据目前微软主流的体系架构（参考Dowamish7体系结构）DOA系统在纵向上采用五层体系结构：UI层、业务逻辑层、数据访问层
13、、支撑层、实体层和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 设备注册页面类关系调用图3.1.2 用户
14、注册描述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.3 类详细描述页面继承基类（PageB
16、ase）方法描述函数名称返回类型输入参数极其类型功能描述saveMessagevoid保存注册设备信息ModifyInfomationvoid修改注册设备信息deleteInfovoid删除注册设备信息deleteAccessoriesvoid删除附件信息insertAccessoriesvoid插入附件信息UpLoadFilestring上传图片到服务器saveImagebool上传图片到数据库DeleteFilebool删除服务器上图片FileDeleteDataBasevoid删除数据库图片insertAccessoriesVoid 添加附件getNextMachineCodestrin
17、g获取新的DOA CODEgetNewNoteIDstring获取新的单据编号getNewUniqueNostring获得附件唯一编号getManageIDint获得用户MGR ID属性描述属性属性类型属性状态属性描述ModelName设备型号MachineSN机身号EightBitCode8DCreateUserId单据创建用户IDCreateTime单据创建时间DOAFormNo单据IDProcessState设备状态VendorNum经销商编号VendorName经销商名称EndUser最终客户ImageID图片IDimageUrl图片路径3.2 设备接收描述3.2.1 设备接收页面类关
18、系调用图3.2.2 设备接收类描述l 当用户填写检测结果,点击”确定”时,应用程序则会调用填写检测结果类DOAFormProcess_DOAFormCheckResultList 中的函数checkResultl 用户填写技术处理建议,点击”确定”.应用程序则会调用填写技术处理建议类中的proAdvice函数.l 当用户在处理技术处理建议审批,点击”通过”时,应用程序会调用技术处理建议审批类中的auditingPass函数,点击”拒绝”时,则会调用auditingRefuse函数l 当用户处理设备处理意见审核,点击”紧急审批时”,应用程序则会调用设备处理意见审核类中函数DecidePro_bt
19、nUrgent_Click. 点击”销售PIC审批”则会调用此类中DecidePro_btnSalesPIC_Click 函数,点击” 销售经理审批”则调用此类中DecidePro_btnSalesMGR_Click函数.点击”拒绝”,则会根据相关的权限分别调用UrgentRefuse函数, SalesPICRefuse函数和SalesMGRRefuse函数.l 用户在接收设备确认时,点击确认,则会调用DOA设备接收确认类中的machineReceive函数.3.2.3 类详细描述页面继承基类（PageBase）方法描述函数名称返回类型输入参数极其类型功能描述checkResult检测结果pr
20、oAdvice填写技术处理建议auditingPass技术处理建议审批通过auditingRefuse技术处理建议审批拒绝DecidePro_btnUrgent_Click设备处理意见审核紧急审批通过DecidePro_btnSalesPIC_Click销售PIC意见审核通过DecidePro_btnSalesMGR_Click销售经理意见审核通过UrgentRefuse设备处理意见审核紧急审批拒绝SalesPICRefuse销售PIC意见审核拒绝SalesMGRRefuse销售经理意见审核拒绝machineReceive设备接收确认machineDestination送修目的地updateS
21、tate送修目的地(批处理方法)属性描述属性属性类型属性状态属性描述CheckUserId检测结果用户IDCheckTime检测结果时间FaultDescription检测结果描述AdviseUserId技术处理建议用户IDAdviseTime技术处理建议时间SolutionDescription技术处理建议意见ApproveUserId技术处理建议审批用户IDApproveTime技术处理建议审批时间ApproveState技术处理建议审批状态UrgentEngTime设备处理意见审核紧急审批时间UrgentEngUserId设备处理意见审核紧急审批用户IDUrgentEngApproveS
22、tate设备处理意见审核紧急审批状态NormalPicUserIdsales审批用户NormalPicTimesales审批时间NormalPicApproveStatesales审批状态NormalMgrApproveStatesales经理审批状态NormalMgrUserIdsales经理审批用户NormalMgrTimesales经理审批时间ReceiveSignUserIdReceiveSignTimeSendRepairLocationId选择送修地点SendRepairLocationUserId送修地点选择人SendRepairLocationTime送修地点选择时间4 数据库
23、设计4.1 数据库关系图4.2 数据据库表结构Table NameTable DescriptionColumn TypeLenColumn DescriptionMaxID单据ID表MaxTypenvarchar50类型TypeDatenvarchar50单据类型MaxIDint10单据最大IDMemonvarchar128备注DOAFormDOA处理单DOAFormIdint10DOAFormNonvarchar18DOA处理单IDCreateUserIdint10创建人IDCreateTimedatetime23创建时间DOAFormStateint10DOA单据状态PlanProces
24、s技术确认Planprocessidint10MachineIdint10IDSolutionDescriptionnvarchar512技术部处理建议AdviseUserIdint10建议人AdviseTimedatetime23建议时间ApproveTimedatetime23经理审批时间ApproveStateint10经理审批状态ApproveUserIdint10审批经理IsUrgentchar1是否紧急AllocateTimedatetime23分配审批时间ConclusionTypeint10处理意见（是否换机）ConclusionOthernvarchar32处理意见（其他）U
25、rgentEngUserIdint10eng审批用户UrgentEngTimedatetime23eng审批时间UrgentEngApproveStateint10eng审批状态NormalPicUserIdint10sales审批用户NormalPicTimedatetime23sales审批时间NormalPicApproveStateint10sales审批状态NormalMgrApproveStateint10sales经理审批状态NormalMgrUserIdint10sales经理审批用户NormalMgrTimedatetime23sales经理审批时间ChangeTypeint
26、10换机类型ChangeOptUserIdint10换机操作人ChangeOptTimedatetime23换机操作时间SendRepairLocationIdint10选择送修地点SendRepairLocationUserIdint10送修地点选择人SendRepairLocationTimedatetime23送修地点选择时间AccMachine附件主机关联表AccessoryMachineIdint10UniqueNonvarchar18唯一编码CreateTimedatetime23创建时间ImageURLnvarchar128图片路径CartonSNnvarchar18包装箱机身号
27、MachineSNnvarchar18设备机身号Memonvarchar512备注BinNonvarchar18库位号PlantNonvarchar18货位号AccessoryIdint10附件IDMachineIdint10设备IDServiceCenter服务中心ServiceCenterIdint10Codenvarchar32代码Namenvarchar32名称EnglishNamenvarchar32英文名称Memonvarchar512备注CityIdint10城市IDAddressnvarchar128地址ContactMannvarchar32联系人Telephonenvarc
28、har32电话Locationnvarchar128位置ModifyTimedatetime23修改时间ModifyUserIdint10修改人BitCode6D/8D关系表BitCodeIdint10EightBitCodenvarchar328DSixBitCodenvarchar326DContactMannvarchar32联系人CheckProcess检测表Checkprocessidint10MachineIdint10设备IDCartonFaultTypenvarchar8包装箱状态MachineFaultTypenvarchar8设备状态FaultDescriptionnvar
29、char512检测结果（故障问题描述）ChechFeedecimal10检测费用IsRepairchar1是否修理IsChangeCartonchar1是否换箱CheckUserIdint10检测人CheckTimedatetime23检测时间Cartons包装箱维护CartonIdint10Namenvarchar32包装箱名称EnglishNamenvarchar32英文名称Weightfloat53重量Lengthfloat53长度Heightfloat53高度Colornvarchar16颜色Memonvarchar512备注Widthfloat53宽度CCFCCF单据CheckCom
30、missionFormIdint10CheckCommissionFormNonvarchar18委托检测单单号Stateint10CCF单据状态RepairCenterIdint10维修中心IDMemonvarchar512备注WareHouseIdint10仓库IDCreateUserIdint10创建用户CreateTimedatetime23创建时间City城市CityIdint10CityNamenvarchar32城市名称EnglishCityNamechar18城市名称（英文）Zonenvarchar32区域Memonvarchar512备注Customers客户信息Custom
31、erIdint10CompanyNamenvarchar128客户名称ContactNamenvarchar32客户公司名称Addressnvarchar128地址PostCodenvarchar12邮编ContactTitlenvarchar32联系人titleMobilenvarchar32手机CityNamenvarchar32城市名称Regionnvarchar32区域Countrynvarchar32城市Phonenvarchar32电话Faxnvarchar32传真ModifyUserIdint10修改人IDModifyTimedatetime23修改时间CustomerNumnv
32、archar32备用字段Dapertments部门信息DapertmentIdint10部门IDNamenvarchar32部门名称EnglishNamechar18英文名称Telephonenvarchar32部门电话Descriptionchar18描述CartonProcess包装箱处理CartonProcessidint10MachineIdint10设备IDCartonSNnvarchar18包装箱机身号CategoryTypenvarchar8换箱类型ChangeUserIdint10换箱类型决定人ChangeTimedatetime23换箱类型决定时间ChangeApproveS
33、tateint10换箱审批状态ChangeApproveUserIdint10换箱审批人ChangeApproveTimedatetime23换箱审批时间CartonIdint10包装箱IDFunctionRole功能角色对应表FunctionIdint10权限IDRoleIdint10角色IDSystemMaxID系统IDTableNamechar30表名Serialint10当前最大数量ExecuteProcess设备维修确认表Executeprocessint10MachineIdint10设备IDDecisionTypenvarchar8最终处理意见（是否修理）DecisionFeed
34、ecimal10费用DecisionMemonvarchar512备注DecideUserIdint10处理意见决定人DecideTimedatetime23处理意见决定时间InitialProcess设备相关人员表InitialProcessidint10InitialProcess设备相关人员表InitialProcessidint10MachineIdint10设备IDSolutionAdviseUserIdint10选择销售的操作人EngMgrIDint10ENG经理IDSalesUserIdint10相关销售SalesMgrUserIdint10相关销售经理GoodsIssuetoM
35、发货设备关系表MachineIdint10GoodsIssueIdint10发货单IDImageInfo图片信息表ImageIDint10图片IDimageUrlnvarchar100存储路径ReceiveGoodsIs收货信息表ReceiveGoodsIssueIdint10ReceiveGoodsNonvarchar18取货单IDDeliveryCompanynvarchar128发货单位DeliveryAddressnvarchar128发货地址DelivererNamenvarchar32发货人名称DelivererTelephonenvarchar32发货人电话DelivererMo
36、bilenvarchar32发货人手机ReceiptorFaxnvarchar32接收人传真ReceiveCompanynvarchar128接收公司ReceiveAddressnvarchar128接收地址ReceiptorNamenvarchar32接收人名字ReceiptorTelephonenvarchar32接收人电话ReceiptorMobilenvarchar32接收人手机ReceiveTimedatetime23接收时间Transporternvarchar128承运人ShipToPartynvarchar18卸货地址WareHouseIdint10仓库IDPlantNonva
37、rchar18货位号BinNonvarchar18库位号Routenvarchar18运输方式Remarksnvarchar32备注VehicleNonvarchar18车辆号DeliverySignnvarchar32发货签章ReceipteSignnvarchar32接收签章ShipSignnvarchar32到货签字CreateUserIdint10创建人IDCreateTimedatetime23创建时间ModifyUserIdint10修改人IDModifyTimedatetime23修改时间StorageLocationIdint10货物存储位置ShippingPointIdint10到货地点ReceiveGoodsStateint10单据状态DeliveryFaxnvarchar32发货传真DeliveryTimedatetime23发货时间
