initial import
This commit is contained in:
William Sandner
173
Use-Case-Format.md
Normal file
173
Use-Case-Format.md
Normal file
@@ -0,0 +1,173 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](srs.html) > [Use Case Suite](use-case-suite.html) > Use Case Format
|
||||
---
|
||||
|
||||
**Process impact:** This reference page documents the format of use
|
||||
cases and gives tips on writing use cases. You can copy and paste the
|
||||
sample use case into your [Use Cases](use-cases) document. This
|
||||
file itself should not be edited to hold specific use cases.
|
||||
|
||||
*TODO: Use this template once in your [Use Cases](use-cases)
|
||||
document. Anything you mention here will apply to all use cases in that
|
||||
file.*
|
||||
|
||||
---
|
||||
### Aspects common to all use cases
|
||||
|
||||
#### Direct Actors:
|
||||
- ::User: end-user in any role
|
||||
- ::System: The system being built
|
||||
- ::When actors are not listed, assume User is doing it.
|
||||
- ::Items beginning with "see" indicate that System has presented a new screen.
|
||||
|
||||
#### Stakeholders:
|
||||
::The user who is entering the data, and those who will read it
|
||||
|
||||
#### Prereq:
|
||||
::Project is set up
|
||||
|
||||
|
||||
*TODO: Copy and paste this use case template as many times as needed in
|
||||
your [Use Cases](use-cases.html) document. Only use those fields that
|
||||
are not the same as the default for all use cases.*
|
||||
|
||||
---
|
||||
### UC-00: USE CASE NAME
|
||||
|
||||
**Summary:**
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
**Priority:**
|
||||
|
||||
::Essential | Expected | Desired | Optional
|
||||
|
||||
**Use Frequency:**
|
||||
|
||||
::Always | Often | Sometimes | Rarely | Once
|
||||
|
||||
**Direct Actors:**
|
||||
|
||||
::ACTOR1, ACTOR2, ACTOR3
|
||||
|
||||
**Stakeholders:**
|
||||
|
||||
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
|
||||
|
||||
**Prereq:**
|
||||
|
||||
- ::PRECONDITION
|
||||
- ::PRECONDITION
|
||||
- ::PRECONDITION
|
||||
|
||||
**Main Success Scenario:**
|
||||
|
||||
- ::STEP
|
||||
- ::STEP
|
||||
- ::STEP
|
||||
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
**Notes and Questions**
|
||||
|
||||
- ::NOTE
|
||||
- ::NOTE
|
||||
- ::QUESTION
|
||||
- ::QUESTION
|
||||
|
||||
---
|
||||
### Format of Use Case Steps
|
||||
|
||||
Try to start each step with one of these action words:
|
||||
|
||||
#### login \[as ROLE or USER\]
|
||||
Log into the system with a given user or a user of the given type.
|
||||
Usually usually only stated explicitly when the test case involves a
|
||||
workflow between different users.
|
||||
|
||||
#### visit LOCATION
|
||||
Visit a page or GUI window. State the user's intention, don't say
|
||||
too much about UI choices that could change later. E.g., WRONG:
|
||||
"Press the 'Advanced...' button on the File | Page Setup dialog".
|
||||
RIGHT: "Visit the page margin configuration dialog".
|
||||
|
||||
#### enter INFORMATION
|
||||
Fill in specific information. Try to state the information in
|
||||
some detail. E.g., WRONG: "Enter customer information." RIGHT:
|
||||
"Enter customer shipping address and discount code." Don't commit to
|
||||
details of a particular UI, i.e., don't name specific UI fields that
|
||||
might change later.
|
||||
|
||||
#### COMMAND
|
||||
Describe a command that the user can tell the system to do. State
|
||||
the user's intent, not the label on a particular UI widget. This
|
||||
will usually be followed by a "see" step where the user sees a
|
||||
confirmation of their action. E.g., WRONG: "Control-P, OK". RIGHT:
|
||||
"Print the current document with default settings".
|
||||
|
||||
#### see CONTENT
|
||||
The user should see the specified information on the currently
|
||||
presented web page or GUI window. Try to be specific about the
|
||||
information that is seen, but try not to refer to specific
|
||||
UI elements. E.g., WRONG: "see UserList.jsp" (what is the user
|
||||
supposed to notice on that page?) RIGHT: "see list of users with the
|
||||
newly added user in the list".
|
||||
|
||||
#### perform USE-CASE-NAME
|
||||
This is like a subroutine call. The user will do all the steps of
|
||||
the named use case and then continue on with the next step of this
|
||||
use case.
|
||||
|
||||
### Further Information {#further-information}
|
||||
|
||||
For more information on advice, see:
|
||||
|
||||
- Words of wisdom on [use case suites](http://readyset.tigris.org/words-of-wisdom/use-case-suite.html).
|
||||
- Words of wisdom on [use cases](http://readyset.tigris.org/words-of-wisdom/use-cases.html).
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user