《软件架构设计说明书》由会员分享，可在线阅读，更多相关《软件架构设计说明书（16页珍藏版）》请在文档大全上搜索。
1、实用文档文案大全<XXX> 架构设计说明书版本 1.0.0签署栏拟制审核批准修订历史版本说明作者审核修订日期1.0发布Dick目录1. 引言 41.1 目的 51.2 范围 51.3 预期的读者和阅读建议 51.4 术语、首字母缩写 61.5 参考资料 62. 系统逻辑结构 112.1 总体结构 112.2 系统功能实现 122.3 组件接口 122.4 组件功能 122.5 数据库关系模型 123. 系统物理实现 134. 系统部署 145. 系统其它考虑 145.1 系统可扩展性 145.2 系统可靠性 145.3 系统性能 155.4 系统维护性 155.5 系统安全 155
2、.6 系统异常处理 156. 约束 156.1 设计指南 156.2 编码规范 156.3 配置文件约定 156.4 日志文件约定 156.5 运行目录约定 15实用文7. 需求矩阵 16文案大全实用文档1. 引言对于由多个进程构成的复杂系统，系统设计阶段可以分为：架构设计（构架设计）、组件高层设计、组件详细设计。对于由单个进程构成的简单系统，系统设计阶段可以分为：系统概要设计、系统详细设计。本文档适用于由多个进程构成的复杂系统的构架设计。架构设计说明书是软件产品设计中最高层次的文档，它描述了系统最高层次上的逻辑结构、物理结构以及各种指南，相关组件（粒度最粗的子系统）的内部设计由组件高层设计提
3、供。系统：指待开发产品的软件与硬件整体，其软件部分由各个子系统嵌套组成，子系统之间具有 明确的接口；组件：指粒度最粗的子系统；模块：指组成组件的各层子系统，模块由下一层模块或函数组成；此文档的目的是：1） 描述产品的逻辑结构，定义系统各组件（子系统）之间的接口以及每个组件（子系统）应该实现的功能；2） 定义系统的各个进程以及进程之间的通信方式；3） 描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况、节点之间的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射；4） 系统的整体性能
4、、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计；5） 定义该产品的各个设计人员应该遵循的设计原则以及设计指南，各个编程人员应该遵循的编码规范。建议架构设计工程师与组件设计工程师共同完成此文档。架构设计说明书的引言应提供整个文档的概述。它应包括此文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。1.1 目的简要描述体系结构文档的目的。1.2 范围简要说明此文档的范围：它的相关项目以及受到此文档影响的任何其它事物1.3 预期的读者和阅读建议说明此文档的阅读对象，简要说明此文档中其它章节包含的内容与文档组织方式，对于不同读者的阅读方式建议。如：目标读者是系统最终用户、系统分析
5、员、项目经理、产品经理、市场人员等。此文档的第2章描述本项目的组织架构和参与人员如下：A 项目负责人：参与开发策划，负责批准项目开发计划书；安排项目组成人员 从技术和业务上总体把握； 确定项目进度及检验标准 了解开发中存在问题，并及时制定相应对策。B 技术总协调：负责制订软件标准。负责支撑软件的维护。评估将在其中部署项目最终产品的目标组织的情况。协调目标组织的建模工作。在必要时对业务工程工作进行讨论和协调。对目标组织中所建议的任何变更进行成本效益分析。C 系统分析、设计：负责获取用户最终需求，概括系统的功能和界定系统来领导和协调需求获取及用例建 模，编写XXX新版本软件详细设计，制订命名规范。
6、软件构架设计，划分子模块并详细描述各模块功能、要求，和测试要点。对软件架构中重要的类做详细说明，描述其属性、方法、和相互之间的关系。数据库设计，包括定义表、索引、视图、约束条件、触发器、存储过程等。D.软件开发：严格按照软件详细设计说明，负责自己开发的模块的资料、软件的备份及保管工作。 在软件开发中如发现系统分析设计时漏洞提出异议，提交问题报告至项目负责人。对各自编写的内容相互交换作单元测试。负责用户使用手册的编写。E.文档编写：负责编写软件详细设计说明书、数据库设计说明书、测试方案文档。F.软件测试：负责对各模块的集成测试，和软件的整体评估测试，在测试完后负责编写测试报 告。1.4术语、首字
7、母缩写序号缩写英文说明中文说明1ACCAFC Clearing CenterAFC清算管理中心2ACLAccess Control List访问控制列表3ACPIAdvanced Configuration andPower Interface先进的配置和电源接口4AFCAutomatic Fare Collection自动售检票5AGMAutomatic Gate Machine自动检票机6ALDTAdministrative and LogisticsDown Time行政和后勤响应时间7ALUArithmetic Logic Unit算术逻辑部件8ASAAdaptive Security
8、 Algorithm适应的安全算法序号缩写英文说明中文说明9AVMAdd Value Machine自动充值机10BCDBinary Code DecimalBCD码指每位十进制数用 4位二进制数编码表示的方法11BIOSBasic Input-Output System微机的基本输入输出系统12MACMuniciple Administration &Communication Card Co.巾政交通.通13BOMBooking Office Machine半自动售票机14CPUCentral Processing Unit中央处理器15CRCCyclic Redundancy C
9、heck循环冗余校验16DATDigital Audio Tape数字音频磁带17DBDatabase数据库18DBADatabase Administrator数据库管理员19DDLData Definition Language数据定义语言20DDSDigital Data Storage数字数据存储21DESData Encryption Standard数据加密标准22DefaultGatewayDefault Gateway默认网关23DMZDe-militarised zone非军事区24DoSDenial of Service拒绝服务25DRPDynamic Routing Pr
10、otocol动态路由协议26DSCPDifferentiated Services CodePoint区分服务代码27E/SEncoder/Sorter Machine车票编码分拣机28EBEmergency Button紧急按钮29ECCError Checking and Correcting错误检查校正30ECUEquipment Control Unit设备的主要控制单元序号缩写英文说明中文说明31EEPROMElectrically ErasableProgrammable Read-OnlyMemory电可擦除只读内存32EMCElectromagnetic Campatibili
11、ty电磁兼容性33EnGEntry Gate进站自动检票机34ExGExit Gate出站自动检票机35Fail-OverFail-Over容错36FC-ALFibre Channel Arbitrated Loop光纤通道仲裁环37FCSWFiber Channel Switch光纤通道交换机38FDDFloppy Disk软盘39GUIGraphical User Interface图形用户接口40H/WHardware硬件41HAHigh Availability局可用性42HDHard Disk硬盘43HDDHard Disk Drive硬盘驱动器44Hot StandbyUnitHo
12、t Standby Unit热备份单元45I/OInput/Output输入/输出46IDIdentification身份47IDEIntegrated Drive ElectronicsIDE 接口48ISAIndustry Standard Architecture工业标准结构总线49KbpsKilo (thousand) bits per second千比特/秒（速率）50KMSKey Management System密钥管理系统51LANLocal Area Network局域网52LCDLiquid Crystal Display液晶显示器53LCLine Center线路中央计算
13、机系统序号缩写英文说明中文说明54LCSLine Computer System线路计算机系统55LEDLow Emitting Diode发光二极管56LTOLinear Tape Open线性磁带开放协议57MACMessage Authentication Code消息认证码58MAKMemory Access Key内存存取密钥59MbpsMega (Million) bits per second兆比特/秒（速率）60MCBFMean-Cycles Between Failure平均无故障时间61MCUMain Control Unit主控单元62MHzMega Hertz兆协兹（频
14、率）63MTBFMean-Time Between Failure平均无故障时间64MIIRMean Time To Repair平均故障恢复维修时间65N/WNetwork网络66NICNetwork Interface Card网络接口卡67NMSNetwork Management System网络管理系统68NTPNetwork Time Protocol网络时间协议69OAOffice Automation办公自动化70OTTotal Operating Time总运营时间71PCIProtocol Control Information一种局部总线72PCI-XPeripheral
15、 ComponentInterconnect Extended扩展的PCI73PeerPeer端74QAQuality - Assurance质量保证75RAIDRandom Array of InexpensiveDisks磁盘阵列76RDBMSDatabase Management System数据库管理系统序号缩写英文说明中文说明77RFRadio Frequency射频78RMONRemote Monitoring远程监控79RSERouting Switching Engine路由交换引擎80S/WSoftware软件81SLEStation Level Equipment车站现场设
16、备82SAMSecure Access Module安全存取模块83SANstorage area network存储网络84SNMPSimple Network ManagementProtocol简单网络管理协议85SCStation Computer system车站计算机系统86SCSISmall Computer System Interface小型计算机接口87STTotal Standby Time总待机时间88TCMTicket Checking Machine自动查询机89TCP/IPTransmission ControlProtocol/Internet Protocol
17、传输控制协议/网际协议90TFT-LCDThin Film Transistor-Liquid CrystalDisplay薄膜晶体管液晶显示器91TomTransactions Per Minute每分钟内系统处理的交易个数92TVMTicket Vending Machine自动售票机93UPSUn-interruptible Power Supply不间断电源94USBUniversal Serial Bus通用串行总线95VLANVirtual Local Area Network虚拟局域网96VRRPVirtual Router RedundancyProtocol (IETF)虚拟
18、路由器冗余协议9710/100Base-FX10/100Base-FX10/100Base -FX 标准序号缩写英文说明中文说明98Usecase viewUsecase view99Implementation viewImplementation view100Activity viewActivity view101Class viewClass view102UMLUnified Modeling Language1.5参考资料此软件架构文档引用文件如下:计算机软件开发规范GB8566-88计算机软件产品开发文件编制指南GB/T 8567-2003计算机软件需求说明编制指南GB9385
19、-88计算机软件测试文件编写规范GB9386-88计算机软件可靠性及可维护性管理GB/T14394-1993计算机软件质量保证计划规范GB/T12504-1990计算机软件配置管理计划规范GB/T12505-1990计算机软件测试文件编制规范GB/T9386-1988软件维护指南GB/T14079-1993软件文档管理指南GB/T16680-1996软件质量评价ISO/IEC 145892.系统逻辑结构本章描述系统的总体逻辑结构，包括组件（子系统）的划分与依赖关系定义、组件之间的接口定义、系统功能在组件之间的实现流程、组件功能定义2.1 总体结构本节定义系统的总体逻辑结构，定义组件划分以及组件
20、之间的依赖关系。为了能够使系统具有较好的可重用性以及能够控制对第三方系统的依赖性（如第三方系统软件、中间件等），在结构设计时可以采用分层方法。系统可以分为专用应用层、通用应用层、中间件层、系统软件层。为了统一与便于理解，当用图形化表示组件（子系统）、组件之间的依赖关系时，要求采用UML 的符号与表示方法。2.2 系统功能实现针对产品需求说明书中定义的功能特性，在此描述它们在相关组件（子系统）之间是如何实现的，系统功能实现描述是定义组件之间的接口以及组件功能的基础，选择若干代表性的用例来说明。在此要求用两种方式来描述功能实现：1） UML 的顺序图；2） 对顺序图的文字解释需要注意的是UML 顺
21、序图中的生命线代表组件（子系统）。产品需求说明书中各个功能特性的数据流图或顺序图描述是此处设计的基础。2.3 组件接口本节明确定义：各个组件之间的接口（系统内部接口）。如果组件之间采用通信协议作为接口，则需要详细定义应用层协议以及低层通信方式。如果采用API 作为接口，则需要详细定义API接口函数（包括参数定义）。系统的所有对外接口在产品需求说明书中明确定义。2.4 组件功能本节明确定义各个组件的软件功能，其依据是产品需求说明书以及系统功能实现描述。本节通常按照组件进行组织。2.4.1 组件 12.5 数据库关系模型 本节在逻辑层面上定义系统所包含的主体数据库模型，以及主要的实体关系，通常以E
22、-R 图形式来表现。tx_update_recvstattx_db_recvstatusw_card_specialtfst_batccardidstartvarchar(9) <pk>cardidendvarchar(9)tradedatetimestampdealtypevarchar(1)registtypevarchar(2)operatorvarchar(6)picplabasicplanlasicrule ,artprice Initprice InitsHividenotradetype tradedatereceivedate startflag startdate
23、 startaddress startterminalvarchar(9)- varchar(2) timestamp timestamp integer timestamp varchar(10) varchar(9) oncardtypevarchar(2)tradetypevarchar(2)tradeaddressvarchar(10)tradedatetimestamp <pk>terminalidvarchar(9) <pk>operatorvarchar(6)trademoneyintegertradevalueintegercurrentvalueint
24、egerforegiftintegerchargeintegercardsninteger <pk>terminalsnintegerterminalsumintegertacvarchar(8)receivedatetimestamptradesnintegerreceivesnintegerstartdatetimestampstartaddressvarchar(10)startterminalvarchar(9)dataresourcevarchar(1)td_common_bakcaididvaichai(9)<pk>cardtypevarchar(2)tra
25、detypevarchar(2)tradedatetimestamp<pk>terminalidvarchar(9)<pk>operatorvarchar(6)trademoneyintegercardsninteger<pk>statevarchar(6)receivedatetimestampcardtype tradedatereceivedate customernamesexcustomerid idtypepin addressphonevarchar(9) varchar(2) timestamp timestamp varchar(16) v
26、archar(1) varchar(20) varchar(2) varchar(16) varchar(100)tradeaddress tradedate terminalid operator receivedate terminalsn orgcurrency orgamt exchangerate curcurrency curamtvarchar(10) timestamp varchar(9) varchar(6) timestamp integer varchar(3) integer varchar(8) varchar(3) integertd_fartradetype t
27、radedatereceivedate farebasic startdate startaddress startterminalvarchar(9)- varchar(2) timestamp timestamp integer timestamp varchar(10) varchar(9)lade lade Hceiv Bsto lex type sto pinrow_idnumeric(io)row_id0numeric(10)command_idvarchar(3)born_timetimestampsend_timetimestampresend_timeintegervalid
28、_timeintegeraspectvarchar(1)add_addrvarchar(16)dest_addrvarchar(16)statusvarchar(1)contentvarchar(4000)row_id row_id0 command_id born_time send_time resend_time valid_time aspect add_addr dest_addr status contentif_reprocessnumeric(10) numeric(10) varchar(3) timestamp timestamp integer integer varch
29、ar(1) varchar(16) varchar(16) varchar(1) varchar(4000) varchar(1)row_id row_id0 command_id born_time send_time resend_time valid_time aspect add_addr dest_addr status contentnumeric(10) numeric(10) varchar(3) timestamp timestamp integerinteger varchar(1)varchar(16) varchar(16) varchar(1) varchar(400
30、0)systemid seqno subseqno operatortype classlclass2 statusclass3differnum tradenumremainsum differmoney trademoney remainmoney operator relationer co_systemid operatordate sendupflagvarchar(9) varchar(10)varchar(2) varchar(2) varchar(2) varchar(20) varchar(1) varchar(20) integer integer integer inte
31、ger integer integervarchar(6) varchar(6) varchar(9) timestamp varchar(1)<pk><pk><pk>wh_functionlftctron_i" nction_name subsystem help_seqno help_title help_filememo，ade_rightvarchar(40) varchar(100) varchar(10) varchar(10)varchar(100) varchar(100) varchar(2000) varchar(20)tx_d
32、b_send3 .系统物理实现本章明确定义各个组件的可执行程序名与库名、可执行程序与库的运行环境。可以采用如下表 的方式来描述（一个组件包含一个可执行程序与多个库）。这是下一步设计与开发的分工依据。组件名可执行程序/库名运行环境组件1定义系统包含的所有进程、每个进程包含的可执行程序名与库名、可执行程序与库的运行环 境。可以采用如下表的方式来描述（一个进程包含一个可执行程序与多个库，与组件不同的是，进 程间可以包含相同的库）。这是实际环境运行反映，也是系统部署的依据。进程名进程运行方式可执行程序/库名运行环境进程1说明进程是以 控制台、Windows 服务程序、Unix后 台进程或者其它方 式运
33、行4 .系统部署本章描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每 种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况（包括硬件、操作系统、支 撑软件）、节点之间的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射。5 .系统其它考虑本章描述系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计。5.1 系统可扩展性描述系统可扩展性设计与实现方案。需要对性能、功能、网管/审计、报表的可扩展性进行描述。5.2 系统可靠性描述系统可靠性设计与实现方案，包括系统的可靠性设计，有硬件可用性与软件可用性两个方面。5.3
34、 系统性能描述系统性能设计与实现方案。5.4 系统维护性 描述系统可维护性设计与实现方案。5.5 系统安全描述系统安全性设计与实现方案。系统安全性包括网络安全、系统安全、数据安全、交易安全等。 5.6 系统异常处理给出系统中的错误类别，以及各类错误的处理要求。同时对系统中的各个组件的错误异常的处理提出具体的要求。6 . 约束本章给出设计人员与编码人员必须遵循的设计要求与编码要求，包括各种代码的命名、配置文件、日志文件格式定义。可以通过引用的方式来写本章节。研开中心将会提供几种主要语言的编码规范，在此可以引用。6.1 设计指南规定在组件设计中的各种约定与标准。6.2 编码规范规定在系统实现中必须遵循的编码规定，包括编码风格、变量与函数命名、注释等。6.3 配置文件约定规定系统的所有配置文件命名方式与格式。6.4 日志文件约定规定系统的所有日志文件命名方式与格式。6.5 运行目录约定规定系统的运行目录结构。7 .需求矩阵序号需求来源Requirement设计Priority123文案大全ArtifactJ = Write / responsible lor = Contribute，review Q = FormaHy Accept
