Escolar Documentos
Profissional Documentos
Cultura Documentos
DocumentName ApplicationUseCase
ApplicationUseCaseTemplate
Workingwithtemplates
Thisdocumentservesasthebasisfordetailinganapplicationusecase.Thesectionsofthis
documentshouldnotbealteredinanyway.IfasectionisnotapplicabletypethewordN/Ainto
thatsection.
ProjectName
ApplicationName
DocumentName
ApplicationUseCase
Version#
July6,2009
TableofContents
TableofContents
TableofFigures
1 Introduction
1.1 Purpose
1.2 Audience
1.3 Scope
1.4 Definitions,Acronyms,andAbbreviations
1.5 Goals
2 DocumentNameUseCaseDetails
2.1 BriefDescription
2.2 Usage
2.3 PrimaryActor
2.4 SupportingActors
2.5 Precondition(s)
2.6 SuccessfulPostCondition
2.7 AlternatePostConditions
2.8 BasicFlow
2.9 AlternateFlows
2.10 ExtensionPoints
2.11 ActivityDiagram
3 UseCasePerformanceRequirements
4 UseCaseSupplementaryRequirements
5 InterfaceRequirements
TableofFigures
Figure1: ExampleUseCase
Figure2: ExampleActivityDiagram
Introduction
Thissectionservesasanoverviewoftheusecase.
1.1 Purpose
TheApplicationUseCase(AUC)documentcapturesalltherequirementsfortheDocument
Nameusecase.
1.2 Audience
Foreachrolethatisexpectedtoreviewthisdocumentdescribehowthisdocumentisusefulto
theirrole.
1.3 Scope
ThisdocumentcontainsasingleusecasefortheApplicationNamesystemanditssupporting
requirements.
Containsanoverviewoftheinformationinthisdocument.
1.4 Definitions,Acronyms,andAbbreviations
SeetheglossaryinReqProforacompletelistoftermsusedonthisproject.
1.5 Goals
Thissectiondescribesthepurposeofthisusecase.
DocumentNameUseCaseDetails
Thissectiondetailstheusecase.
2.1 BriefDescription
Ashortdescriptionoftheusecasefocusingonhowitenablesactorstoachievetheirgoals.
Insertausecasediagram.
2.2 Usage
Indicatethenormalandpeakfrequencythatthisusecasecanbeexpectedtoexecute.
2.3 PrimaryActor
Statetheprimaryactorsroleinthisusecase.
2.4 SupportingActors
Listallsupportingactorrolesinthisusecase.
2.5 Precondition(s)
Thisisthestateofthesystembeforetheusecasestart.Assuchitisnotcheckedduringexecution
oftheusecase,insteaditisassumedthatitisnotpossibletoexecutetheusecaseitthe
preconditionhasnotbeensatisfied.(Ifthesystemdisplaysanerrorbecausesomethinghasnot
previouslyoccurred,donotlistitasaprecondition,butdescribeitinanexceptionflow.)In
generalapreconditionindicatesthatsomeotherusecasehasruntocompletionpriortothisuse
caseexecuting.Inthatsenseapreconditioncanbeseenasthepostconditionofsomeotheruse
case.Acommonexampleofapreconditionistheactorhasloggedontothesystem.
2.6 SuccessfulPostCondition
Thisistheconditionofthesystemafterthecompletionofthebasicflow.
2.7 AlternatePostConditions
Thisistheconditionofthesystemaftertraversinganextensionflow.
2.8 BasicFlow
1. <enterusecasestepshere>
Typeeachlineoftheusecaseusingthe'Normaltextstyle.Whencomplete,seteachsteptostyle
'UseCaseStep'.Thiswillautomaticallynumberthesteps.
Thebasicflowisthenormalflowofeventsthatthisusecaseisintendedtoexecute.
Ifsystemdoesmultiplethingsinnoparticularorderinresponsetotheactorsaction,further
splitthoseintoseveralsubstepsifitincreasesclarity,and,usebulletpointstoformatthe
substeps(indicatingthatthereisnoordertothesequenceinwhichthestepsareexecuted).
Indicatetheendofaflowbytypingthewords'Endusecase'.
Ifseveralstepsaretoberepeated,writetherepetitioninstructionaftertherepeatingsteps.
Howtoincludeadifferentusecase:
Whenincludinganotherusecase,referencetheusecasenameandidentifierinthestep.
2.9 AlternateFlows
1.1.1.1.1.1.1.1.1<Enteralternateflownamehere>
2. <enteralternatestepshere>
Alternativeflowisasthenamesuggestsadifferentpathausecasecanfollowtoreacha
successfulpostcondition.Itstartswithacondition(whichisstatedintheAlternativeFlowtitle)
andcontainsasetofstepsdescribingwhathappensunderthatcondition.
Usuallyanalternativeflowendsbysimplyremergingwiththebasicflowataparticularstep.
Whenthatisnotthecase,clearlyindicatetheendoftheusecasewiththestatementUsecase
ends.MakesurethepostconditionofthisflowisconsistentwittheSuccessfulPost
Condition(s).
Enteralternateflowheadingandtextusingthe'Normalbody'style.Donotreferencestepsin
theusecaseyet.Setthealternateflowheadingtostyle'AlternateFlow'.Seteachalternateflow
steptostyle'AlternateStep'.
Whereanalternateflowstepmakesreferencetoastepintheusecasebody,usethe
'Insert>Reference>CrossReference'commandtoreferencetheparagraphnumber.
Whereanalternateflowisreferencedfromabasicstep,usethe'Insert>Reference>Cross
Reference'commandtoreferencetheparagraphnumber.
2.10 ExtensionPoints
i. <Enterextensionflownamehere>
3. <enterextensionstepshere>
Alistoflocationswithintheflowofeventsoftheusecaseatwhichadditionalbehaviorcanbe
inserted.
Unlesstheactionistrivial,documentextensionstoausecaseintheirownusecasedocument.
Indicatethattheusecaseisextendedbyusingtheextendrelationshiptoconnecttheusecasesin
ausecasediagram.
[Exampleusecase:
2.DocumentNameUseCase
Thissectiondetailstheusecase.
2.1Description
Theprimaryfunctionofthedematerializeristobreakdownthecargointoparticlesthatmaybe
sentbythetransmitter.Ablueprintofthecargoissenttotheblueprintmanager.
Figure1:ExampleUseCaseDiagram
2.2PeakUsage
TheDematerializermayneedtobeusedupto5timesaday.
2.3PrimaryActor
Cargohandler.
2.4SecondaryActors
Transmitter
2.5Precondition(s)
TheDematerializerisina'ReadyToTransport'state.
2.6PostCondition(s)
TheDematerializerisina'ReadyToTransport'state.
2.7BasicFlow
1.SystemreceivesanOpenDoorcommand.
2.Thesystemopensthedoor.
3.(Thecargoisloaded),Thesystemreceivesacommandtotransportthecargo.
4.Thetransmitteris'ReadytoTransmit'andthesystemclosesthedoor.
5.Thedoorisclosedandthesystem:
.securesthecargo.
.createsavacuum.
6.Thecargoisreadytobedeconstructedandthesystem:
.sendsablueprintofthedeconstructedcargototheBlueprintManager.
.deconstructsthecargoandsendsthedeconstructedmattertotheTransmitter.
7.Thecargohasbeensenttothetransmitterandsystemremovesthevacuum.
Theusecaseends.
2.8AlternateFlows
A.1Thetransmitterisnotready:
8.Atstep4,thesystemwaitsforthetransmittertoindicatethatitisready.
9.Transmitterindicatesthatitisready.
Returntostep4.
2.9ExtensionPoints
E.1Thesystemisconfiguredtoautomaticallyshutdownaftersuccessfultransmission.
10.Atstep7thesysteminformstheuserthatitisshuttingdown.
11.Thesystemshutsdown.
Theusecaseends.]
2.11 ActivityDiagram
Thefollowingdiagramrepresentsthestepsoftheusecase.Theinputsarerepresentedbycontrol
flowsbetweenactivities.Theactivitiesrepresenttheworkdonebythesystem.Theinitialstate
representsthepreconditionoftheusecaseandthefinalstatesarethepostconditions.Alternative
andextensionflowsarerepresentedbydecisions.Whereanalternativeflowreturnstothebasic
flowitisrepresentedbyamerge.
Placeanactivitydiagramherethatdescribestheusecaseflow.
Figure2:ExampleActivityDiagram
UseCasePerformanceRequirements
Thefollowingrequirementsapplytothestepsoftheusecase.Everysystemstepintheusecase
shouldhaveanassociatedtiming.Thattimingmayapplytoanindividualsteportoagroupof
steps,solongaseverystepiscovered.
<insertperformancerequirementhere>
[Example
Atstep2,thesystemdoorwillopenwithin10seconds.]
UseCaseSupplementaryRequirements
Thefollowingsupplementaryrequirementsimpactthisusecase.Theyaregatheredhereduring
thedetailingoftheusecaseandshouldbemovedtothesupplementaryfolderofReqProonce
theusecasehasbeenimportedtoReqPro.
<insertsupplementaryrequirementhere>
InterfaceRequirements
Wheretheusecaseinterfaceswithanotheractor,referencetheappropriatestandardsfor
developingthatinterface.Thereferencemaybetoanindustrystandard,companystandardora
'tobedeveloped'interfacedocument.
[Aninterfaceshouldbedescribedinitsownseparateinterfacedocument,andnotintheuse
case.InterfacerequirementsarenotimportedintoReqPro.]
<insertinterfacerequirementhere>