Difference between revisions of "Use cases"

From ICA-AtoM
Jump to navigation Jump to search
Line 1: Line 1:
[[Main Page]] > [[System Requirements]] > [[Use cases]] >
+
[[Main Page]] > [[System Requirements]] > Use cases
  
 +
Use cases describe scenarios from the end-users' perspective of their day to day activities. Individual use cases are clustered around the same broad categories as the functional requirements:
 +
 +
*[[USC-1 Establish a system of control]]
 +
*[[USC-2 Add / edit content]]
 +
*[[USC3 Translate content]]
 +
*[[USC-4 Access content]]
 +
*[[USC-5 Import / export content]]
 +
*[[USC-6 Administer the system]]
 +
 +
 +
The following generic actors are invoked in the use cases:
 +
*Institution: a body having custody and control of archival materials.
 +
*Archivist: a staff member of an Institution.
 +
*Network: a group of Institutions sharing descriptions and other information relating to archival materials.
 +
*Administrator: a person responsible for the application of an Institution or Network.
 +
*Researcher: a person who accesses the archival materials held by Institutions.
 +
 +
 +
Each use case includes the following information:
  
<span id="USC-1.2.1"></span>
 
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
  
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
|- valign="top" align="left" style="background:#00008B; color:white"
| colspan="3" | Implement arrangement policy
+
| colspan="3" | Use case name
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| width="100" rowspan="4" style="background:silver" | Summary
 
| width="100" rowspan="4" style="background:silver" | Summary
 
! width="150" | ID number
 
! width="150" | ID number
| width="700" | 1.2.1
+
| width="700" | USC-x.x.x (unique tracking number assigned to requirement)
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Overview
 
! Overview
 
|  
 
|  
An institution establishes its arrangement policy and customizes the application to implement it.
+
Brief description of the scenario.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Primary actor
 
! Primary actor
| Institution.
+
|  
 +
The main actor involved in the scenario.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Secondary actor
 
! Secondary actor
| Administrator.
+
|  
 +
Other actors involved in the scenario.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| rowspan="5" style="background:silver" | Description
 
| rowspan="5" style="background:silver" | Description
 
! Preconditions
 
! Preconditions
| n/a
+
|
 +
Other use cases whose completion is a precondition for the current case.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Trigger
 
! Trigger
| n/a
+
|  
 +
The event that initiates the current case.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Successful outcome
 
! Successful outcome
 
|  
 
|  
*Application customized so users implement policy.
+
The outcomes of a successful resolution of the scenario.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Main scenario
 
! Main scenario
 
|  
 
|  
1. Institution establishes the highest level of arrangement it will employ.
+
Step-by-step breakdown description of the scenario ("Scenario A").
 
 
2. Institution establishes the number of levels of arrangement it will employ. E.g. series is the highest level, three series levels (series, sub- and sub-sub-series) allowed.
 
 
 
3. Administrator edits "Levels of description" taxonomy so drop-down lists use levels and terms allowed by policy.
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Exceptions / variations
 
! Exceptions / variations
| TextHere
+
|  
 +
Other possible variations, including unsuccessful outcomes ("Scenario B", "Scenario C" etc).
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
| rowspan="4" style="background:silver" | Requirements
+
| rowspan="3" style="background:silver" | Requirements
 
! Functional requirements
 
! Functional requirements
 
|  
 
|  
*[[FNC1]]
+
Links to associated functional requirements (FNC-x).
*[[FNC2]]
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Metadata requirements
 
! Metadata requirements
 
|  
 
|  
*[[MTD1]]
+
Links to associated metadata requirements (MTD-x).
*[[MTD2]]
 
 
 
|- valign="top" align="left"
 
! Quality requirements
 
|
 
*Requirement1.
 
*Requirement2.
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! Technical requirements
 
! Technical requirements
 
|  
 
|  
*[[TCR1]]
+
Links to associated technical requirements (TCN-x).
*[[TCR2]]
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
! style="background:silver" | Diagrams
 
! style="background:silver" | Diagrams
| colspan="2" | DiagramHere
+
| colspan="2" |  
 
+
Work-flow or other diagrams illustrating the scenario.
|- valign="top" align="left"
 
| rowspan="2" style="background:silver" | ICA-AtoM
 
! Implementation
 
| TextHere
 
 
 
|- valign="top" align="left"
 
! Known issues
 
|
 
*Issue1.
 
*Issue2.
 
  
 
|}
 
|}

Revision as of 18:31, 30 April 2008

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Main Page > System Requirements > Use cases

Use cases describe scenarios from the end-users' perspective of their day to day activities. Individual use cases are clustered around the same broad categories as the functional requirements:


The following generic actors are invoked in the use cases:

  • Institution: a body having custody and control of archival materials.
  • Archivist: a staff member of an Institution.
  • Network: a group of Institutions sharing descriptions and other information relating to archival materials.
  • Administrator: a person responsible for the application of an Institution or Network.
  • Researcher: a person who accesses the archival materials held by Institutions.


Each use case includes the following information:

Use case name
Summary ID number USC-x.x.x (unique tracking number assigned to requirement)
Overview

Brief description of the scenario.

Primary actor

The main actor involved in the scenario.

Secondary actor

Other actors involved in the scenario.

Description Preconditions

Other use cases whose completion is a precondition for the current case.

Trigger

The event that initiates the current case.

Successful outcome

The outcomes of a successful resolution of the scenario.

Main scenario

Step-by-step breakdown description of the scenario ("Scenario A").

Exceptions / variations

Other possible variations, including unsuccessful outcomes ("Scenario B", "Scenario C" etc).

Requirements Functional requirements

Links to associated functional requirements (FNC-x).

Metadata requirements

Links to associated metadata requirements (MTD-x).

Technical requirements

Links to associated technical requirements (TCN-x).

Diagrams

Work-flow or other diagrams illustrating the scenario.