Difference between revisions of "Application UseCase Template"
From Earth Science Information Partners (ESIP)
m |
m |
||
Line 1: | Line 1: | ||
− | = | + | =Use Case <Cluster>.<SubArea>.<number>.<letter>: <Short Name>= |
E.g. | E.g. | ||
Line 37: | Line 37: | ||
further details. | further details. | ||
− | Through this use case, the system User | + | Through this use case, the system User does THIS and it results in THIS and is used for THIS. |
===Actors=== | ===Actors=== | ||
Line 46: | Line 46: | ||
====Primary Actors==== | ====Primary Actors==== | ||
The actor that initiates this use case is the portal User. | The actor that initiates this use case is the portal User. | ||
− | Providers may also initiate this use case as a precursor to use case | + | Providers may also initiate this use case as a precursor to use case NNN... |
====Other Actors==== | ====Other Actors==== | ||
===Preconditions=== | ===Preconditions=== | ||
− | *1. | + | *1.XXX available |
− | *2. | + | *2.YYY validated |
− | *3. | + | *3.ZZZ published |
===Postconditions=== | ===Postconditions=== | ||
− | *1.Datasets | + | *1.Datasets are .. |
− | *2.Appropriate action | + | *2.Appropriate action ... |
− | *3.Controls are | + | *3.Controls are ... |
===Normal Flow (Process Model)=== | ===Normal Flow (Process Model)=== | ||
− | *1)The user selects | + | *1)The user selects ... |
− | *2)The user | + | *2)The user then ... |
− | *3)The results of the | + | *3)The results of the XXX are ... |
− | *4)The user | + | *4)The user ... |
===Alternative Flows=== | ===Alternative Flows=== | ||
− | *1)The user selects the | + | *1)The user selects the alternate ... |
− | *2)The user | + | *2)The user then ... |
===Successful Outcomes=== | ===Successful Outcomes=== | ||
Line 91: | Line 91: | ||
===Use Case Diagram=== | ===Use Case Diagram=== | ||
− | ===State Diagram=== | + | ===State Diagram (optional)=== |
− | ===Activity Diagram=== | + | ===Activity Diagram (optional)=== |
− | ===Other Diagrams=== | + | ===Other Diagrams (optional)=== |
− | ==Non-Functional Requirements== | + | ==Non-Functional Requirements (optional)== |
===Performance=== | ===Performance=== | ||
Line 133: | Line 133: | ||
====Limitations==== | ====Limitations==== | ||
− | ==References== | + | ==References (optional)== |
None | None |
Revision as of 14:48, January 12, 2007
Use Case <Cluster>.<SubArea>.<number>.<letter>: <Short Name>
E.g. Use Case AQ.Smoke.1.a: Smoke plume event detection and related dataset discovery <Cluster>={AQ, DM, EC, EF, PH, WM} <number>={1, 2, 3, ...} <letter>={a, b, c, ...}
Purpose
Earth Information Exchange
Revision Information
Version X.N.a (can be labeled draft if X=0)
Prepared by <Author(s) with responsibility>
<Affiliation>
<Date/Time created>
Revision History
Modified by <Modifier Name/Affil>, <Date/time>, <Brief Description>
Use Case Identification
Use Case Designation
<Cluster>.<SubArea>.<number>.<letter>
Use Case Name
<Insert short name and long name>
Use Case Definition
First paragraph is short description, second paragraph, etc. may contain further details.
Through this use case, the system User does THIS and it results in THIS and is used for THIS.
Actors
Always identify primary actors, may be more than one. Also identify other actor including any other systems or services which are important.
Primary Actors
The actor that initiates this use case is the portal User. Providers may also initiate this use case as a precursor to use case NNN...
Other Actors
Preconditions
- 1.XXX available
- 2.YYY validated
- 3.ZZZ published
Postconditions
- 1.Datasets are ..
- 2.Appropriate action ...
- 3.Controls are ...
Normal Flow (Process Model)
- 1)The user selects ...
- 2)The user then ...
- 3)The results of the XXX are ...
- 4)The user ...
Alternative Flows
- 1)The user selects the alternate ...
- 2)The user then ...
Successful Outcomes
- 1.Operation succeeds and user obtains QQQ.
Failure Outcomes
- 1.Operation fails to return any XXX. Should instead YYYY.
- 2.Illegal input of AAA, Should instead ZZZZ
Special Functional Requirements
None
Extension Points
- <Cluster>.<SubArea>.<number>.<letter+1> something added or a variant.
E.g. AQ.Smoke.1.b something added or a variant
- <Cluster>.<SubArea>.<number>.<letter+2> something added or a variant
- <Cluster>.<SubArea>.<number>.<letter+3> something added or a variant
Diagrams
Use Case Diagram
State Diagram (optional)
Activity Diagram (optional)
Other Diagrams (optional)
Non-Functional Requirements (optional)
Performance
Reliability
Scalability
Usability
Security
Other Non-functional Requirements
Selected Technology
Overall Technical Approach
Architecture
Technology A
Description
Benefits
Limitations
Technology B
Description
Benefits
Limitations
References (optional)
None