Use Case Template
Use Case Template
Version xx
May 4, 2010
Use Case ID:
Effective
Date
Affected Sections
Author
Reviewer
Approver
Page ii
TABLE OF CONTENTS
1
Brief Description.....................................................................................................4
1.2
Pre-Conditions........................................................................................................4
1.3
Actors....................................................................................................................4
1.3.1
1.3.2
Primary........................................................................................................................4
Secondary....................................................................................................................4
1.4
1.5
Trigger Points.........................................................................................................4
1.6
Flow of Events........................................................................................................5
1.6.1
1.6.2
1.6.2.1
1.6.3
Exception Flows.............................................................................................................6
1.6.3.1
1.7
Post Conditions.......................................................................................................6
1.8
1.9
Business Rules..............................................................................................................6
Processing Rules............................................................................................................7
Messages...............................................................................................................7
1.11 Notes....................................................................................................................8
1.11.1 <<Note 1>>.................................................................................................................8
Page iii
1.2 Pre-Conditions
[A precondition of a use case is the state of the system that must be present prior to a use case being performed.
Precondition is a constraint on when a Use-Case can start. It is not the event that starts the Use-Case .Precondition
is not for only one sub flow. Do not mention other Use-Cases as Precondition. The emphasis here is state of System
required to proceed with the Use-Case. Examples of pre-conditions: The Actor has been authenticated. The Actor
has been authorized to perform the Use Case that initiated this use case]
1.3 Actors
1.3.1 Primary
[There is only one and only one Primary Actor for each use case. If at first it appears that there are multiple
Primary actors for the Use-Case then it indicates some analysis is needed so that multiple actors can be generalized
(abstracted) into a single base (parent) actor. This base actor embodies a common role played by multiple actors. A
Primary Actor could be a person or an external system.]
1.3.2 Secondary
[Secondary actors are supporting actors that are needed for successful completion of Use-Case. They could be
persons or external systems.]
View Contacts
Agent
CMS
Page 4
Always use extension points, which are like a heading to describe the next set of steps. The extension points will
be very useful when returning to a point in the Main Flow from an Alternate Flow
2.
Always use hyperlinks to link other parts of the Use Case, like Processing Rules, Alternate Flows or Page
Properties, etc. It enhances readability
3.
Use simple English. Avoid complex sentences. If you have to state multiple points in the same sentence, break
them up into bulleted list. Please bear in mind that the consumers of a Use Case is a human being, not a
machine.
4.
The Main Flow should not be more than 10 to 12 steps long; the shorter the better. If there are more than 10 to
12 steps, evaluate whether it can be broken down
5.
Do NOT elaborate Error / Warning messages in the flow. Refer to a separate Messages document where all
Messages are articulated.
6.
Always specify a reference to a Page / Screen from any given step in the flow. This enhances clarity with people
looking at the relevant screen while reading the Use Case
7.
Describe only the events that belong to the use case, and not what happens in other use cases or outside of the
system
8.
Avoid vague terminology such as "for example", "etc. " and "information"
9.
Make sure you use business terms consistently across all Use Cases]
Actor
System
[An Alternate Flow is where the Actor can choose to be, unlike an Exception Flow, where the Actor is automatically
landed by the System.
An Alternate Flow must always have an origin in the Main Flow or in another Alternate Flow it cannot just
appear out of nowhere
An Alternate Flow must always have an origin in the Main Flow or in another Alternate Flow it cannot just
appear out of nowhere]
Page 5
Actor
System
[An Exception Flow is where the Actor is forced into by the System. For e.g. Validation Failure, External System
Communication Exception]
#
Actor
System
Page 6
Should there be an initiative in the future to consolidate all Business Rules in a Rules Engine, it will be
easy if there is a separate document capturing all Business Rules.
2.
Since a given Business Rule can be relevant for more than one Use Case, capturing Business Rules in
a separate document will avoid duplication
Having said that, it is not incorrect to capture Business Rules relevant for a given Use Case right here in
the Use Case document.
It is another best practice to categorize Business Rules under Transaction, Security, and Administration.
Depending upon the System being built, more categories can be thought of. ]
PR Name
PR Description
Message(s)
1.
1.9 Messages
[Messages are displayed to the Actor during the execution of the Use Case. Messages could be Error
Messages, Warning Messages, Confirmation Messages or Information Messages.
Every Message will have a Message ID, Message Title and the Message Description. It is important that
the Use Case state the exact Message ID and Message Title that will be displayed to the Actor at
appropriate points in the Main, Alternate or Exception Flows
It is a best practice to capture all messages in a separate document for the following reasons:
1.
Corporate Communication team would want to standardize all Messages across all Systems. If
messages are spread in individual Use Cases, it will be difficult to go about the process of
standardization.
2.
Most Systems of today are built for internationalization. Every time there is a decision to
introduce a new language that the System would support, there will be a need to translate, among
others, all Messages too. It will easy to go about the translation process if Messages are captured
in a separate document.
Page 7
Messages can be reused across more than once in a given Use Case as well as across multiple
Use Cases. Describing the Message in one place will avoid duplication and will help during
maintenance.]
1.10.1
1.11 Notes
[If it is found that a specific point / requirement needs more elaboration for people to understand, such
details can be provided in this section. A flow chart or an activity diagram, background to why certain
requirements are needed, etc. can be explained here.]
1.11.1
<<Note 1>>
Page 8
1.12.1
<<Page 1>>
<<Wire Frame goes here>>
Field Name
Type
Size
Mandatory
/ Optional
Display /
Input
Default
Value
Validation
Description / Remarks
Header
Location Name
Mandatory
Text
Location Address
Line1
1.12.2
<<Page 2>>
<<Wire Frame goes here>>
Field Name
Type
Size
Mandatory
/ Optional
Display /
Input
Default
Value
Validation
Description / Remarks
Page 9
1.13.1
Questions
Q#
Title
Question
1.13.2
Assumptions
AS#
Title
Assumption
Validated
(Y/N)
Page 10