Software Architecture Document SAD软件开发文档Word文档下载推荐.docx
- 文档编号:16647210
- 上传时间:2022-11-25
- 格式:DOCX
- 页数:23
- 大小:54.73KB
Software Architecture Document SAD软件开发文档Word文档下载推荐.docx
《Software Architecture Document SAD软件开发文档Word文档下载推荐.docx》由会员分享,可在线阅读,更多相关《Software Architecture Document SAD软件开发文档Word文档下载推荐.docx(23页珍藏版)》请在冰豆网上搜索。
ThistemplateisbasedontheSoftwareEngineeringInstitute’s“ViewandBeyond”methodfordocumentingsoftwarearchitectures,asdescribedinClements,etal.,DocumentingSoftwareArchitecture:
ViewsandBeyond(AddisonWesley,2002).ThecurrentversionisavailableforfreedownloadfromtheSEI’sarchitecturewebsite.
TIPSFORUSINGTHISTEMPLATE
Tocreateaninstanceofthisdocument:
Insertrelevantinformationoncoversheetandinplaceholdersthroughout.
Insertrelevantinformationinpageheader:
Movetoapageofthebodyofthereport,selectView>
HeaderandFooterfromthemainmenu,andthenreplacerelevantinformationintheheaderboxatthetopofthepage.
ToupdatethecontentsandpagenumbersintheTableofContents,ListofFigures,andListofTables:
Positionthecursoranywhereinthetabletobeupdated.
ClicktheF9functionkey.
Answer“Updateentiretable”.
Toinsertafigureortablecaption:
Fromthemainmenu,chooseInsert>
Reference>
CaptionandtheneitherFigureorTableasneeded.
ClicktheOKbutton.
Addacolonandatabstopafterthefigurenumberinthecaptionitself.
ThecaptionshouldusetheCaptionstyle.
Addacolonandatabstopafterthetable/figurenumberinthecaptionitself.
TIPSFORMAKINGYOURDOCUMENTMOREREADABLE
AgrayboxcontainingCONTENTSOFTHISSECTIONisprovidedatthebeginningofmostsectionsandsubsections.Afterdeterminingwhatspecificinformationwillbeincludedinyourdocument,youcanremovethisgrayboxorleaveittoserveasaquick-referencesectionoverviewforyourreaders.Inthecasethattexthasbeenprovidedinthetemplate,inspectitforrelevanceandrevisedasnecessary.
ConsiderhyperlinkingkeywordsusedinthedocumentwiththeirentriesintheGlossaryorotherlocationinwhichtheyaredefined.ChooseInsert>
Hyperlink.
Don’tleaveblanksectionsinthedocument.Markthem“Tobedetermined”(ideallywithapromiseofadateorreleasenumberbywhichtheinformationwillbeprovided)or“Notapplicable.”
ConsiderpackagingyourSADasamulti-volumesetofdocumentation.Itisoftenhelpfultobreakyourdocumentationintomorethanonevolumesothatthedocumentdoesnotbecomeunwieldy.Therearemanywaysthatthiscanbeaccomplished.Thestructuringofthedocumentmustsupporttheneedsoftheintendedaudienceandmustbedeterminedinthecontextoftheproject.Eachdocumentthatyouproduceshouldincludethedateofissueandstatus;
draft,baseline,versionnumber,nameofissuingorganization;
changehistory;
andasummary.Afewdecompositionoptionsare:
A2-Volumeapproach:
Separatethedocumentationintotwovolumes;
onethatcontainstheviewsofthesoftwarearchitectureandonethatcontainseverythingelse.Acommonvariantofthisapproachhasonevolumeperview,andonevolumeforeverythingelse.
A3-Volumeapproach:
Documentorganizationalpolicies,procedures,andthedirectoryinonevolume,systemspecificoverviewmaterialinasecond,andviewdocumentationinathird.
A4-Volumeapproach:
Createonevolumeforeachviewtype[Clements2002](module,component-and-connector,allocation)thatcontainsthedocumentationfortherelevantviews.Includealloftheotherinformationinthefourthvolume.
Softwareinterfacesareoftendocumentedinaseparatevolume.
Inanycase,theinformationshouldbearrangedsothatreadersbeginwiththevolumecontainingtheDocumentationRoadmap(Section1inthistemplate).
TableofContents
1DocumentationRoadmap1
1.1DocumentManagementandConfigurationControlInformation1
1.2PurposeandScopeoftheSAD1
1.3HowtheSADIsOrganized1
1.4StakeholderRepresentation1
1.5ViewpointDefinitions1
1.5.1<
Insertnameofviewpoint>
ViewpointDefinition1
1.5.1.1Abstract1
1.5.1.2StakeholdersandTheirConcernsAddressed1
1.5.1.3Elements,Relations,Properties,andConstraints1
1.5.1.4Language(s)toModel/RepresentConformingViews1
1.5.1.5ApplicableEvaluation/AnalysisTechniquesandConsistency/CompletenessCriteria1
1.5.1.6ViewpointSource1
1.6HowaViewisDocumented1
1.7RelationshiptoOtherSADs1
1.8ProcessforUpdatingthisSAD1
2ArchitectureBackground1
2.1ProblemBackground1
2.1.1SystemOverview1
2.1.2GoalsandContext1
2.1.3SignificantDrivingRequirements1
2.2SolutionBackground1
2.2.1ArchitecturalApproaches1
2.2.2AnalysisResults1
2.2.3RequirementsCoverage1
2.2.4SummaryofBackgroundChangesReflectedinCurrentVersion1
2.3ProductLineReuseConsiderations1
3Views1
3.1<
Insertviewname>
View1
3.1.1ViewDescription1
3.1.2ViewPacketOverview1
3.1.3ArchitectureBackground1
3.1.4VariabilityMechanisms1
3.1.5ViewPackets1
3.1.5.1Viewpacket#j1
3.1.5.1.1PrimaryPresentation1
3.1.5.1.2ElementCatalog1
3.1.5.1.3ContextDiagram1
3.1.5.1.4VariabilityMechanisms1
3.1.5.1.5ArchitectureBackground1
3.1.5.1.6RelatedViewPackets1
4RelationsAmongViews1
4.1GeneralRelationsAmongViews1
4.2View-to-ViewRelations1
5ReferencedMaterials1
6Directory1
6.1Index1
6.2Glossary1
6.3AcronymList1
7SampleFigures&
Tables1
ListofFigures
Figure1:
SampleFigure1
ListofTables
Table1:
StakeholdersandRelevantViewpoints1
Table2:
SampleTable1
1DocumentationRoadmap
TheDocumentationRoadmapshouldbethefirstplaceanewreaderoftheSADbegins.Butfornewandreturningreaders,itisintendedtodescribehowtheSADisorganizedsothatareaderwithspecificinterestswhodoesnotwishtoreadtheSADcover-to-covercanfinddesiredinformationquicklyanddirectly.
Sub-sectionsofSection1includethefollowing.
∙Section1.1(“DocumentManagementandConfigurationControlInformation”)explainsrevisionhistory.Thistellsyouifyou’relookingatthecorrectversionoftheSAD.
∙Section1.2(“PurposeandScopeoftheSAD”)explainsthepurposeandscopeoftheSAD,andindicateswhatinformationisandisnotincluded.Thistellsyouiftheinformationyou’reseekingislikelytobeinthisdocument.
∙Section1.3(“HowtheSADIsOrganized”)explainstheinformationthatisfoundineachsectionoftheSAD.Thistellsyouwhatsection(s)inthisSADaremostlikelytocontaintheinformationyouseek.
∙Section1.4(“StakeholderRepresentation”)explainsthestakeholdersforwhichtheSADhasbeenparticularlyaimed.ThistellsyouhowyoumightusetheSADtodoyourjob.
∙Section1.5(“ViewpointDefinitions”)explainstheviewpoints(asdefinedbyIEEEStandard1471-2000)usedinthisSAD.ForeachviewpointdefinedinSection1.5,thereisacorrespondingviewdefinedinSection3(“Views”).Thistellsyouhowthearchitecturalinformationhasbeenpartitioned,andwhatviewsaremostlikelytocontaintheinformationyouseek.
∙Section1.6(“HowaViewisDocumented”)explainsthestandardorganizationusedtodocumentarchitecturalviewsinthisSAD.Thistellsyouwhatsectionwithinaviewyoushouldreadinordertofindtheinformationyouseek.
1.1DocumentManagementandConfigurationControlInformation
CONTENTSOFTHISSECTION:
Thissectionidentifiestheversion,releasedate,andotherrelevantmanagementandconfigurationcontrolinformationassociatedwiththecurrentversionofthedocument.Optionalitemsforthissectioninclude:
changehistoryandanoverviewofsignificantchangesfromversiontoversion.
∙RevisionNumber:
>
>
∙RevisionReleaseDate:
∙PurposeofRevision:
∙ScopeofRevision:
listsectionsorpagenumbersthathavebeenrevised;
provideasummaryoverviewofthedifferencesbetweenthisreleaseandthepreviousone.>
1.2PurposeandScopeoftheSAD
ThissectionexplainstheSAD’soverallpurposeandscope,thecriteriafordecidingwhichdesigndecisionsarearchitectural(andthereforedocumentedintheSAD),andwhichdesigndecisionsarenon-architectural(andthereforedocumentedelsewhere).
ThisSADspecifiesthesoftwarearchitecturefor<
insertscopeofSAD>
.Allinformationregardingthesoftwarearchitecturemaybefoundinthisdocument,althoughmuchinformationisincorporatedbyreferencetootherdocuments.
Whatissoftwarearchitecture?
Thesoftwarearchitectureforasystemisthestructureorstructuresofthatsystem,whichcomprisesoftwareelements,theexternally-visiblepropertiesofthoseelements,andtherelationshipsamongthem[Bass2003]."
Externallyvisible”propertiesreferstothoseassumptionsotherelementscanmakeofanelement,suchasitsprovidedservices,performancecharacteristics,faulthandling,sharedresourceusage,andsoon.ThisdefinitionprovidesthebasiclitmustestforwhatinformationisincludedinthisSAD,andwhatinformationisrelegatedtodownstreamdocumentation.
Elementsandrelationships.Thesoftwarearchitecturefirstandforemostembodiesinformationabouthowtheelementsrelatetoeachother.Thismeansthatarchitecturespecificallyomitscertaininformationaboutelementsthatdoesnotpertaintotheirinteraction.Thus,asoftwarearchitectureisanabstractionofasystemthatsuppressesdetailsofelementsthatdonotaffecthowtheyuse,areusedby,relateto,orinteractwithotherelements.Elementsinteractwitheachotherbymeansofinterfacesthatpartitiondetailsaboutanelementintopublicandprivateparts.Softwarearchitectureisconcernedwiththepublicsideofthisdivision,andthatwillbedocumentedinthisSADac
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Software Architecture Document SAD软件开发文档 SAD 软件 开发 文档
链接地址:https://www.bdocx.com/doc/16647210.html