软件系统设计说明书模板.docx
- 文档编号:27340600
- 上传时间:2023-06-29
- 格式:DOCX
- 页数:17
- 大小:24.59KB
软件系统设计说明书模板.docx
《软件系统设计说明书模板.docx》由会员分享,可在线阅读,更多相关《软件系统设计说明书模板.docx(17页珍藏版)》请在冰豆网上搜索。
软件系统设计说明书模板
项目名称
ProjectName
密级
ConfidentialityLevel
仅供收件方查阅
项目编号
ProjectID
版本
Version
文档编号
DocumentCode
1.0
ProjectID_SD_003
XXSoftwareSystemDesignSpecification(OO)
XX软件系统设计说明书(OO)
Preparedby
拟制
Date
日期
Reviewedby
评审人
Date
日期
Approvedby
批准
Date
日期
版权所有不得复制
Copyright©BroadenGateTechnologies,Co.,Ltd.
.AllRightsReserved
RevisionRecord
修订记录
Date
日期
RevisionVersion
修订版本
CRID/DefectID
CR/Defect号
SecNo.
修改章节
ChangeDescription
修改描述
Author
作者
Catalog
1Introduction简介1
1.1Purpose目的1
1.2Scope范围1
1.2.1Name软件名称1
1.2.2Functions软件功能1
1.2.3Applications软件应用1
2Level0DesignDescription第0层设计描述1
2.1SoftwareSystemContextDefinition软件系统上下文定义1
2.2DesignConsiderations(Optional)设计思路(可选)1
2.2.1DesignAlternatives设计可选方案2
2.2.2DesignConstraints设计约束2
2.2.3OtherDesignConsiderations其他2
3Level1DesignDescription第一层设计描述2
3.1SystemArchitecture系统结构2
3.1.1DescriptionoftheArchitecture系统结构描述2
3.1.2RepresentationoftheBusinessFlow业务流程说明3
3.2DecompositionDescription分解描述3
3.2.1Module/Subsystem1Description模块1/子系统1描述3
3.2.2Module/Subsystem2Description模块2/子系统2描述3
3.3DependencyDescription依赖性描述3
3.4InterfaceDescription接口描述3
3.4.1Module/Subsystem1InterfaceDescription模块1/子系统1的接口描述4
3.4.2Module/Subsystem2InterfaceDescription模块2/子系统2的接口描述4
4Level2DesignDescription第二层设计描述4
4.1ModuleName
(1)模块1名称4
4.1.1DesignDescription模块设计描述4
4.1.2FunctionIllustration功能实现说明5
4.2ModuleName
(2)模块2名称5
4.2.1DesignDescription模块设计描述5
4.2.2FunctionIllustration功能实现说明5
5DatabaseDesign数据库设计5
5.1EntitiesDefinition实体定义6
5.1.1DecompositionDescription分解描述6
5.1.2InternalDependencyDescription内部依赖性描述6
5.2BehaviorsDefinition行为定义6
5.2.1DecompositionDescription分解描述6
5.2.2ExternalDependencyDescription外部依赖性描述6
5.2.3InternalDependencyDescription内部依赖性描述6
6DetailedDesignofModule模块详细设计7
6.1Class1CLASS的设计7
6.1.1Overview简介7
6.1.2ClassDiagram类图7
6.1.3StatusDesign状态设计7
6.1.4Attributes属性7
6.1.5Methods方法7
6.2Class2CLASS的设计8
7DetailedDesignoftheDatabase数据库详细设计8
7.1StoredProcedure1#/Trigger1#存储过程1#/触发器1#的名称8
7.2StoredProcedure2#/Trigger2#存储过程2#/触发器2#的名称8
Keywords关键词:
Abstract摘要:
Listofabbreviations缩略语清单:
<对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。
Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.>
Abbreviations缩略语
Fullspelling英文全名
Chineseexplanation中文解释
1Introduction简介
1.1Purpose目的
Thissectionshouldstatethepurposeofthisdocument.Theintendedreadershouldalsobespecifiedhere.
这部分要描述文档的目的,并指明文档的读者。
1.2Scope范围
1.2.1Name软件名称
Identifythesoftwarebyname.
对软件命名。
1.2.2Functions软件功能
Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferencetoanotherrelateddocument).
解释软件产品将完成或不完成的功能(可以直接描述也可以参考相关文档)。
1.2.3Applications软件应用
Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftwaredocument)
描述软件的应用领域(可直接描述也可以参考其他软件文档)。
2Level0DesignDescription第0层设计描述
2.1SoftwareSystemContextDefinition软件系统上下文定义
Thissectionshoulddescribetherelationshipsbetweenthesoftwaresystemtobedevelopedandtheexternalentities.Architecturediagramscouldbeusedtodescribethearchitectureandtheinteractions.
本节描述待开发软件系统与外部实体的关系,可以使用系统结构图来描述系统结构和交互关系。
Thedescriptionoftheexternalentities'attributesshallbelimitedtotheseattributeswhichwillinteractwiththesoftwaredesign.Inlieuofacompletedescription,referencecouldbemadetorelevantdocumentationoftheconcernedsoftwareentity,e.g.OSProgrammer'sManual.
外部实体属性描述只限于描述与本系统软件设计相关的属性。
考虑到描述的完整性,可参考相关软件实体文档,如OS程序员手册。
2.2DesignConsiderations(Optional)设计思路(可选)
2.2.1DesignAlternatives设计可选方案
Analyzeseveralalternativesofsystemdesignscheme,andspecifytheschemethatshallbe
used.对本软件系统的几种设计方案进行分析、比较,并确定所采用的方案。
2.2.2DesignConstraints设计约束
1.Standardscompliance遵循标准
Describestandardsthatsoftwaresystemshallcomplywith.描述本软件所遵循的标准、规范。
2.HardwareLimitations硬件限制
Describehardwarelimitationsofthesoftwaresystem.描述本软件系统实现的硬件限制。
3.TechnologyLimitations技术限制
Describetechnologylimitationsofthesoftwaresystem.描述本软件的技术限制。
2.2.3OtherDesignConsiderations其他
Describeotherdesignconsiderationsofthesoftwaresystem.描述其他有关的设计考虑。
3Level1DesignDescription第一层设计描述
3.1SystemArchitecture系统结构
如果本文档是针对增强开发/小特性的设计,继承了原有的系统结构,那么应拷贝原有的系统结构说明,如系统结构图和相应的文字说明,然后在一层设计中明显标识出新增功能在原有系统结构中的位置(属于原来哪一个模块的新增功能,与原有各模块之间有什么交互)。
在后续的业务流程说明、模块分解描述、依赖性描述和接口描述中,如果与本次增强开发/小特性无关的,可以不再重复描述,如果有关联的,应该拷贝原有的设计说明,在此基础上再说明更改的内容。
3.1.1DescriptionoftheArchitecture系统结构描述
Thesoftwaresystemarchitectureshouldbedescribedhere.Architecturediagrams,hierarchicaldecompositiondiagrams,orpackagediagramscouldbeusedtorepresentthearchitecture.Andthepartitioningprinciple,suchasthearchitecturedefinedinastandardprotocol,aschemecomingfromtheanalysismodel,ortheconstraintstobefollowedtointegratewiththelegacysystems,shouldalsobedepicted.Theresponsibilitiesandrelationshipsoftheanalysisclassesshouldbeclarifiedwhileananalysismodelisintroduced.
这里要描述软件系统的总体结构,可以使用结构图、层次分解图或包图来描述,并应说明系统结构划分的原则(例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基于原有体系结构的限制)。
对于使用分析模型的体系结构,应说明分析类的职责及相互关系。
3.1.2RepresentationoftheBusinessFlow业务流程说明
Sequencediagramsorcollaborationdiagramscouldbeusedtoillustratethespecificusecase(s)scenariosfromtheuse-casemodeltorepresentthefinalsystemarchitectureoranalysisclasses,andhowthesearchitecturalmoduleswork.
描述系统架构模块/分析类之间的动态交互,来说明用例模型中的典型用例场景,以体现系统功能是如何实现的。
建议采用Sequence图、Collaboration图等来描述。
3.2DecompositionDescription分解描述
Thissectiondescribesthepackages,sub-systems,modulesinthesystem.
本节描述系统中的子系统和模块。
3.2.1Module/Subsystem1Description模块1/子系统1描述
Don'tactuallywrite"Modulename
(1)".Specifythenameofthemoduleinfewwords.
不要直接写“模块/子系统1”,用简短的词语命名模块/子系统。
Describeasfollows按照以下格式描述:
1.Overview简介
2.Functions功能列表
3.2.2Module/Subsystem2Description模块2/子系统2描述
3.3DependencyDescription依赖性描述
Thissectiondescribestherelationshipsamongthedesignentitiessuchassub-systems,datastores,modules,processes,etc.
本节描述系统中的子系统,数据结构,模块,进程等设计实体间的关系。
Structurecharts,transactiondiagramscouldbeusedtorepresentdependences.
依赖关系描述可以使用文字,结构图,(交互)事务图。
3.4InterfaceDescription接口描述
Thissectiondescribestheinterfacesofthedesignentities(suchassub-systems,modules,processes,etc.)thatmakeupthesystem。
本节描述软件系统中设计实体(如子系统,模块,进程)的接口.
Interfacefiles,parametertablescouldbeusedtodescribetheinterfaces.
接口描述可以使用接口文件,参数表。
Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdiscussedneedtobedescribed.
对于外部实体只有同被描述软件相关的接口才需描述。
Functioncalls、events、messages、signalsshouldbeincluded.
接口可以是函数调用、事件、消息、信号等。
3.4.1Module/Subsystem1InterfaceDescription模块1/子系统1的接口描述
Describeasfollows对每个接口按照以下格式描述:
Name名称:
(Thenameoftheinterface接口名称)
Description说明:
(Briefdescriptionoftheinterface对接口的简短说明)
Definition定义:
(接口原型定义,说明接口类型及相关参数)
3.4.2Module/Subsystem2InterfaceDescription模块2/子系统2的接口描述
4Level2DesignDescription第二层设计描述
EachmodulethatisdefinedinL1andidentifiedforfurtherdescriptionshallbestatedbyseparatesub-sectionsasmentionedbelow.Moresub-sectionlevelscouldbeaddedoptionally,andfinallyallspecificclassescorrespondingtoeachfinalminimalmodule,includingitspublicattributesandpubicmethods,shouldbedefined.
一层设计中定义的每个模块的进一步设计在下面的章节进行描述。
对层次比较多的模块,可以增加设计层次,最终要说明对应于最小分解模块的具体设计类(包括其public属性和public方法)。
Thiswillberepeatedforeachpackage/moduleasfollows.
对每个模块重复使用下述的格式。
4.1ModuleName
(1)模块1名称
Don'tactuallywrite"Modulename
(1)".Specifythenameofthemoduleinfewwords.
不要直接写“模块1名称”,用简短的词语命名模块。
如果本文档是针对增强开发/小特性的设计,继承了原有的二层模块结构,那么应拷贝原有的模块结构说明,如包图/类图和相应的文字说明,然后在二层设计中明显标识出新增功能在原有模块结构中的位置(属于原来哪一个子模块/设计类的新增功能,与原有各子模块/设计类之间有什么交互)。
在后续的功能实现说明和设计类定义中,如果与本次增强开发/小特性无关的,可以不描述,如果有关联的,应该拷贝原有的设计说明,在此基础上再说明更改的内容。
对更改的设计类应该给出类的完整定义,再标识出更改的属性和方法。
4.1.1DesignDescription模块设计描述
Depictthedecompositionofthemodulese.g.thefunctionalityofeachsubmodules.Thedesignclassesshouldbedefinedhere,classdiagramscouldbeusedtodescribethedesignclassesandtherelationshipsamongtheseclasses,andthedesignpattern(s)shouldalsobeinterpreted.
描述模块分解,例如每个子模块的功能定义。
定义出具体的设计类,用类图来描述其相互关系,并说明所采用的设计模式。
Thiswillberepeatedforeachclassasfollows.
对每个类重复使用下述的格式进行描述。
1.Classname1#类名
Shouldbereplacedbyatruedesignclassname.应该用实际的类名替换。
Specificclassescorrespondingtoeachfinalminimalmoduleshouldbedefinedasbelow.
按下面的格式对每个设计类进行说明。
(1)CIIdentification标识
CIIdentificationoftheclasstoberecordedintheSoftwareRequirementsTraceabilityMatrix.
说明该类的配置项标识(用于需求跟踪,配置项的命名方式在CMP中已定义。
一般为:
产品名_模块名_类名,如果在类的命名中未包括前面两部分)。
(2)Overview简介
Overviewofitsresponsibilities.
简单介绍该类的功能。
(3)Definition类定义(Optional)
Classdiagramsorpseudocodescouldbeusedtodepicttheclassdefinitionsindetail,ifitisnotdescribedpreviously.Allthepublicattributesandmethodsshouldbedefinedspecifically.
如果该类在前面没有定义,使用类图、伪代码描述该类的类定义,需说明该类的所有public属性和public方法。
2.Classname2#类名
(1)CIIdentification标识
(2)Overview简介
(3)Definition类定义(Optional)
4.1.2FunctionIllustration功能实现说明
Sequencediagramsorcollaborationdiagrams,etc.couldbeusedtorepresenttherelationshipsamongthedesignclassesandhowthedesignclassesimplementtheirtypicalresponsibilities.
使用Sequence图、Collaboration图等来说明这些设计类之间如何交互,实现本模块的典型功能。
4.
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 系统 设计 说明书 模板
![提示](https://static.bdocx.com/images/bang_tan.gif)