软件设计说明书模板.docx
《软件设计说明书模板.docx》由会员分享，可在线阅读，更多相关《软件设计说明书模板.docx（15页珍藏版）》请在冰豆网上搜索。
软件设计说明书模板
页数
共页
XXSoftwareDesignSpecification
XX软件设计说明书
拟制
姓名+工号
日期
yyyy-mm-dd
审核
日期
yyyy-mm-dd
批准
日期
yyyy-mm-dd
Revisionrecord修订记录
Date
日期
Revisionversion
修订版本
Description
修订描述
Author
作者
yyyy-mm-dd
VX.X
XXX
姓名+工号
DistributionList分发记录
CopyNo.
Holder'sName&Role
持有者和角色
IssueDate
分发日期
1
yyyy-mm-dd
2
yyyy-mm-dd
3
yyyy-mm-dd
4
yyyy-mm-dd
5
yyyy-mm-dd
Catalog目录
1Introduction简介
7
1.1Purpose目的
7
1.2Scope范围
7
1.2.1Name软件名称
7
1.2.2Functions软件功能
7
1.2.3Applications软件应用
7
2HighLevelDesign概要设计
8
2.1Level0DesignDescription第0层设计描述
8
2.1.1SoftwareSystemContextDefinition软件系统上下文定义：
8
2.1.2DesignConsiderations（Optional）设计思路（可选）
8
2.1.2.1DesignMethodology设计方法
8
2.1.2.2DesignAlternatives设计可选方案
8
2.1.2.3DesignConstraints设计约束
8
2.1.2.4OtherDesignConsiderations其他
8
2.2Level1DesignDescription第一层设计描述
9
2.2.1DecompositionDescription分解描述
9
2.2.1.1Module/SubsystemDecomposition模块/子系统分解
9
2.2.1.2ConcurrentProcessDecomposition并发进程处理分解
9
2.2.1.3DataDecomposition数据分解
9
2.2.2DependencyDescription依赖性描述
10
2.2.2.1Module/subsystemDependencies模块/子系统间的依赖关系
10
2.2.2.2ProcessDependencies进程间依赖关系
10
2.2.2.3DataDependencies数据依赖关系
10
2.2.3InterfaceDescription接口描述
10
2.2.3.1Module/SubsystemInterfaces模块/子系统接口
10
2.2.3.2ProcessInterfaces进程接口
11
2.3Level2DesignDescription第二层设计描述（Optional）
12
2.3.1Modulename
（1）模块1名称
12
2.3.1.1DecompositionDescription分解描述
12
2.3.1.2DependencyDescription依赖性描述
12
2.3.1.3InterfaceDescription接口描述
12
2.4Database（Optional）数据库（可选）
13
2.4.1Entity,Attributesandtheirrelationships实体、属性及它们之间的关系
13
2.4.2E-Rdiagram实体关系图
13
3DetailedDesign详细设计
14
3.1Module1DetailDesign模块一详细设计
14
3.1.1DataDescription数据描述
14
3.1.1.1SimpleDataDescription简单数据描述；
14
3.1.1.2Structure1orClass1结构1或类1
14
3.1.1.3Structure2orClass2结构2或类2
14
3.1.2FunctionDescription函数描述
15
3.1.2.1Function1函数1
15
3.1.2.2Function2函数2
16
Tableofcontentsforthetable表目录
Table1XX表1XX
6
Tableofcontentsforthefigure图目录
Figure1XX图1XX
7
XXSoftwareDesignSpecification
XX软件设计说明书
Keywords关键词：
Abstract摘要：
Listofabbreviations缩略语清单：
.
1
Introduction简介
.1Purpose目的
Thissectionshouldstatethepurposeofthedocument.Itcouldalsospecifytheintendedaudience.
这部分要描述文档的目的，并指明适用的读者。
.2Scope范围
.1Name软件名称
Identifythesoftwarebyname
对软件命名
.2Functions软件功能
Explainwhatthesoftwareproduct（s）willandwillnotdo（eitherdirectlyorbyreferencetoanothersoftwaredocument）.
解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）
.3Applications软件应用
Describetheapplicationoftheproduct（eitherdirectlyorbyreferencetoanothersoftwaredocument）
描述软件的应用（可直接描述也可以参考其他软件文档）
2
HighLevelDesign概要设计
.1Level0DesignDescription第0层设计描述
.1SoftwareSystemContextDefinition软件系统上下文定义：
Thissectiondescribesrelationshipsbetweenthesoftwaresystemtobedevelopedandexternalentities.ArchitectureDiagram,DFD（Data-Flow-Diagram）ortransactiondiagramscanbeusedtodescribearchitectureandinteraction.
本节描述待开发软件系统与外部实体的关系.，可以使用系统结构图、数据流图、事务图等来描述系统结构和交互关系。
外部实体属性描述只限于软件设计和描述相关的属性。
考虑到描述的完整性，可参考相关软件实体文档，如OS程序员手册。
.2DesignConsiderations（Optional）设计思路（可选）
.1DesignMethodology设计方法
Describedesignmethodoloythatshallbeusedinthesoftwaresystemdesign.描述本软件系统所采取的设计方法
.2DesignAlternatives设计可选方案
Aanalysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshallbeused.对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案
.3DesignConstraints设计约束
1.Standardscompliance遵循标准
Describestandardsthatsoftwaresystemshallcomplywith.描述本软件所遵循的标准、规范
2.HardwareLimitations硬件限制
Describehardwarelimitationsofthesoftwaresystem.描述本软件系统实现的硬件限制
3.TechnologyLimitations技术限制
Describetechnologylimitationsofthesoftwaresystem.描述本软件的技术限制
.4OtherDesignConsiderations其他
Describeotherdesignconsiderationsofthesoftwaresystem.描述其他有关的设计考虑
.1
Level1DesignDescription第一层设计描述
Architectureofthesoftwaresystemshallbedescribedhere.这里要描述软件系统的总体结构。
Architecturediagram,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedtorepresentthearchitecture.总体结构描述可以使用结构图，层次分解图，自然语言。
.1DecompositionDescription分解描述
.1Module/SubsystemDecomposition模块/子系统分解
Thissectiondescribessubsystems,moduleinthesystem..本节描述系统中的子系统和模块。
1.Module/Subsystem1Description模块/子系统1描述
Describeasfollows按照以下格式描述：
Identification标识：
Type类型：
Purpose目的：
Functions功能列表：
.2ConcurrentProcessDecomposition并发进程处理分解
Thissectiondescibesconcurrentprocessesinthesystem..本节描述系统中的并发进程。
Incaseofexternalentities,Subordinatesattributeneednotbedescribed.对于外部实体，从属属性不必描述。
1.Process1Description进程1描述
Describeasfollows按照以下格式描述：
Identification标识：
Type类型：
Purpose目的：
Functions功能列表：
.3DataDecomposition数据分解
Thissectiondescibesdatastoresinthesystem..本节描述系统中的数据结构。
Externaldataentitiesshallnotbedescribed.外部数据实体不必描述。
1.DataEntity1Description数据实体1描述
Describeasfollows按照以下格式描述：
Identification标识：
Type类型：
Purpose目的：
.2DependencyDescription依赖性描述
Thissectiondescibesrelationshipsamongthedesignentitiessuchassubsystems,datastores,modules,andprocessesetc..本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。
Structurecharts,dataflowdiagrams,transactiondiagrams，ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用结构图，数据流图，（交互）事务图,ER图。
.1Module/subsystemDependencies模块/子系统间的依赖关系
Thissectiondescribesrelationshipsamongsubsystems，modules。
本节描述子系统，模块间的关系。
DependenciesdescriptioncanbeorganizedbyFunctionsorbyModules.
依赖关系的描述可以按功能进行组织，也可以按模块进行组织。
Structurecharts,dataflowdiagrams,transactiondiagramscanbeusedtorepresentdependences.依赖关系描述可以使用结构图，数据流图，（交互）事务图.
.2ProcessDependencies进程间依赖关系
Thissectiondescibesrelationshipsamongprocesses
本节描述进程间的关系。
dataflowdiagrams,transactiondiagramscanbeusedtorepresentdependences.依赖关系描述可以使用结构图，数据流图，（交互）事务图。
.3DataDependencies数据依赖关系
Thissectiondescibesrelationshipsamongdatastores。
本节描述数据结构间的关系。
ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用ER图。
.3InterfaceDescription接口描述
Thissectiondescribesinterfacesofthedesignentities（suchassubsystem,module,process）thatmakeupthesystem。
本节描述软件系统中设计实体（如子系统，模块，进程）的接口.
Interfacefiles,parametertablescanbeusedtodescribeInterface.接口描述可以使用接口文件，参数表。
Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.对于外部实体只有同被描述软件相关的接口才需描述。
.1Module/SubsystemInterfaces模块/子系统接口
ThissectiondescribesinterfacesofModule/SubsystemInterfaces。
本节描述模块/子系统的接口。
1.Module/Subsystem1Description模块/子系统1描述
Describeasfollows按照以下格式描述：
Identification标识：
Type类型：
Purpose目的：
Functions功能列表：
.2ProcessInterfaces进程接口
Thissectiondescribesinterfacesofprocess。
本节描述进程的接口。
1.Process1Description进程1描述
Describeasfollows按照以下格式描述：
Identification标识：
Type类型：
Purpose目的：
Functions功能列表：
.1
Level2DesignDescription第二层设计描述（Optional）
EachentitythatisdefinedinL1andidentifiedforfurtherdescriptionshallbedescribedbyseparatesub-sectionsasmentionedbelow.L1中定义的每个实体的进一步设计在下面的章节进行描述。
Thiswillberepeatedforeachmoduleasfollows.
对每个模块重复使用下述的格式。
.1Modulename
（1）模块1名称
Don'tactuallywrite"Modulename
（1）".Specifythenameofthemoduleinfewwords.
不要写直接“模块1名称”，用简短的词语命名模块，
.1DecompositionDescription分解描述
Provideanddescribethedecompositionofthemodule.E.g.thefunctionalityofeachsubmodules
描述模块的分解，并描述每个子模块的功能等属性。
.2DependencyDescription依赖性描述
Describethedependencywithinthemodule.I.e.dependencywithintwosubmodules
描述模板内部的依赖关系，如两个子模块的依赖关系等。
.3InterfaceDescription接口描述
Describetheinterfacewithinthemodule.I.e.interfacewithintwosubmodules
描述模块内部的接口关系，如两个子模块间的接口等。
.1
Database（Optional）数据库（可选）
.1Entity,Attributesandtheirrelationships实体、属性及它们之间的关系
Thissectioncouldlistalltheentitiessuchasdatastores,averbosedescriptionofwhatthatentitypertainstoandlistofallitsattributes.Foreachoftheattributes,itsdatabase,thedatasize,specificconstraintsandaverbosedescriptionofthatattributeshouldbespecified.Allspecificconstraintsforthatentityanditsrelationshipwithotherentitiesshouldalsobenoted.
本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。
对每个属性，详细描述其数据库、数据大小、特定约束。
实体的所有约束及实体间的关系也要注明。
.2E-Rdiagram实体关系图
ThissectionshoulddisplaytheE-Rdiagramforalltheentitieslistedabove.
本节描述关于上节提到的所有实体的E-R图
1
DetailedDesign详细设计
ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheSoftwareDesignDocument.
本节应该集中描述软件实体的详细描述，而这些实体作为软件部件在软件设计文档中得到描述。
.1Module1DetailDesign模块一详细设计
Describedatathatdefinedorusedinthemodule,including:
simpledatai.e.globalvariableorconstantwithinthemodule;
complexdatai.e.classorstructure....
描述模块中定义和使用的数据，包括：
简单数据，如模块级的全局变量、常量；
复合数据，如模块内部的类、结构，...；
.1DataDescription数据描述
describesimplevariablesandconstantofthemoduleinsection3.1.1.1;
describecomplexdatafromsection3.1.1.2,suchasclass、structure;
在3.1.1.1中描述本模块中的简单变量、常量；
从3.1.1.2起描述本模块中的复合数据，如类、结构等；
.1SimpleDataDescription简单数据描述；
describesimplevariables、constantusedordefinedinthismodule;
描述在本模块中定义和使用的简单变量、常量；
.2Structure1orClass1结构1或类1
defineanddescribetheDatastructure;
定义和说明该数据结构；
.3Structure2orClass2结构2或类2
.2
FunctionDescription函数描述
DescribetherelationshipsofthefunctionswithinModule
描述模块内函数的调用关系
.1Function1函数1
Descriptthefunctionasfollows;
Function:
//nameoffunction
Description:
//f
升级会员 