Difference between revisions of "Use cases"

From ICA-AtoM
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
[[Main Page]] > [[System Requirements]] > Use cases
+
[[Main Page]] > [[System requirements]] > Use cases
  
 
== Purpose ==
 
== Purpose ==
  
−
Use cases describe interactions with the application from the end-users' point of view. Use cases provide tests of the application's functionality and identify issues that need to be addressed in future releases.
+
Use cases describe interactions with an application from the end-users' point of view in a variety of ''what if'' scenarios. Use cases:
  
 +
*Identify [[Functional requirements|functional]], [[Metadata requirements|metadata]], and [[Quality requirements|quality requirements]].
  
−
== Structure ==
+
*Test the application's current functionality.
  
−
Use cases are clustered around the same broad categories as the functional requirements. Like the latter, use cases are organized hierarchy with high-level scenarios broken down into more specific tests (sub- and sub-sub-cases). To facilitate cross-references and links, each case has been assigned an alpha-numeric code: the alpha prefix designates its type (USC = use case), the number establishes its position in the hierarchy. Six main use cases have been identified:  
+
*Identify issues that need to be addressed in future releases.
−
*[[USC-1 | USC-1 Implement a system of control]]
+
 
−
*[[USC-2 | USC-2 Add / edit content]]
+
*Support development of user-end documentation.
−
*[[USC-3 | USC-3 Translate content]]
+
 
−
*[[USC-4 | USC-4 Access content]]
+
 
−
*[[USC-5 | USC-5 Import / export content]]
+
== Organization ==
−
*[[USC-6 | USC-6 Administer the system]]
+
 
 +
Use cases are clustered around the same broad categories as the [[Functional requirements|functional requirements]]. Like the latter, use cases are organized hierarchy with high-level scenarios broken down into more specific tests (sub- and sub-sub-cases). To facilitate cross-references and links, each case has been assigned an alpha-numeric code: the alpha prefix designates its type (UC = use case), the number establishes its position in the hierarchy. Six main use cases have been identified:
 +
 
 +
*[[UC-1|UC-1 Implement a system of control]]
 +
 
 +
*[[UC-2|UC-2 Add / edit content]]
 +
 
 +
*[[UC-3|UC-3 Translate content]]
 +
 
 +
*[[UC-4|UC-4 Access content]]
 +
 
 +
*[[UC-5|UC-5 Import / export content]]
 +
 
 +
*[[UC-6|UC-6 Administer the system]]
  
  
Line 20: Line 34:
  
 
The following generic actors are invoked in the use cases:
 
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.
+
*'''Institution''': a body having custody and control of archival materials.
−
*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.
+
*'''Archivist''': a staff member of an Institution.
−
*Researcher: a person who accesses the archival materials held by Institutions.
+
 
 +
*'''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.
  
  
 
== Information ==
 
== Information ==
  
−
Each use case includes the following information:
+
Each use case includes some or all of the following information:
 +
 
 +
Summary
 +
 
 +
*'''Use case number''': UC-x.x.x, unique tracking number assigned to the use case.
 +
 
 +
*'''Use case name''': descriptive name assigned to requirement.
 +
 
 +
*'''Context (parent requirements)''': links to higher-level cases, if applicable.
 +
 
 +
*'''Sub-requirements''': links to lower-level cases, if applicable.
 +
 
 +
*'''Overview''': brief description of the scenario.
 +
 
 +
*'''Actors''': the main actor(s) involved in the scenario.
 +
 
 +
 
 +
Description
  
−
{| border="1" cellpadding="2"
+
*'''Preconditions''': other use cases whose completion is a precondition for the current case.
  
−
|- valign="top" align="left" style="background:#00008B; color:white"
+
*'''Trigger''': the event that initiates the current case.
−
| colspan="3" | USC-x.x.x (unique tracking number assigned to case).
 
  
−
|- valign="top" align="left"
+
*'''Successful outcome''': the outcomes of a successful resolution of the scenario.
−
| width="100" rowspan="3" style="background:silver" | Summary
 
−
! width="150" | Use case name
 
−
| width="700" | Descriptive name assigned to use case
 
  
−
|- valign="top" align="left"
+
*'''Main scenario''': step-by-step breakdown describing the scenario as leading to a successful outcome.
−
! Overview
 
−
|
 
−
Brief description of the scenario.
 
  
−
|- valign="top" align="left"
+
*'''Exceptions / variations''': other possible variations, including unsuccessful outcomes ("Scenario B", "Scenario C" etc).
−
! Actor
 
−
|
 
−
The main actor(s) involved in the scenario.
 
  
−
|- valign="top" align="left"
 
−
| rowspan="5" style="background:silver" | Description
 
−
! Preconditions
 
−
|
 
−
Other use cases whose completion is a precondition for the current case.
 
  
−
|- valign="top" align="left"
+
Requirements
−
! Trigger
 
−
|
 
−
The event that initiates the current case.
 
  
−
|- valign="top" align="left"
+
*'''Functional requirements''': links to associated functional requirements (FR-x).
−
! Successful outcome
 
−
|
 
−
The outcomes of a successful resolution of the scenario.
 
  
−
|- valign="top" align="left"
+
*'''Metadata requirements''': links to associated metadata requirements (MR-x).
−
! Main scenario
 
−
|
 
−
Step-by-step breakdown description of the scenario ("Scenario A").
 
  
−
|- valign="top" align="left"
+
*'''Technical requirements''': links to associated technical requirements (TR-x).
−
! Exceptions / variations
 
−
|
 
−
Other possible variations, including unsuccessful outcomes ("Scenario B", "Scenario C" etc).
 
  
−
|- valign="top" align="left"
 
−
| rowspan="3" style="background:silver" | Requirements
 
−
! Functional requirements
 
−
|
 
−
Links to associated functional requirements (FNC-x).
 
  
−
|- valign="top" align="left"
+
Documentation
−
! Metadata requirements
 
−
|
 
−
Links to associated metadata requirements (MTD-x).
 
  
−
|- valign="top" align="left"
+
*'''Diagrams''': work-flow or other diagrams illustrating the scenario.
−
! Technical requirements
 
−
|
 
−
Links to associated technical requirements (TCN-x).
 
  
−
|- valign="top" align="left"
+
*'''User Manual''': links to the [[User manual]] sections that provide step-by-step instructions for activities relating to the scenario.
−
| style="background:silver" | Diagrams
 
−
| colspan="2" |
 
−
Work-flow or other diagrams illustrating the scenario.
 
  
−
|}
 
  
−
Note that most of this detail will only be found at the lower-level cases. Higher-level cases will typically only include the case name, number, and overview, with links to the lower-level sub-requirements.
+
== Index of use cases ==
  
 +
The following is the full index to use cases identified to date.
  
−
== Index ==
 
  
−
[[USC-1 | '''USC-1 Implement a system of control''']]
+
[[UC-1|'''UC-1 Implement a system of control''']]
−
*[[USC-1.1 | USC-1.1 Define system scope]]
+
*[[UC-1.1|UC-1.1 Define system scope]]
−
**[[USC-1.1.1 | USC-1.1.1 Implement a multi-repository network]]
+
**[[UC-1.1.1|UC-1.1.1 Implement a multi-repository network]]
−
**[[USC-1.1.2 | USC-1.1.2 Implement a local stand-alone application]]
+
**[[UC-1.1.2|UC-1.1.2 Implement a local stand-alone application]]
−
**[[USC-1.1.3 | USC-1.1.3 Integrate a local application with an existing system]]
+
**[[UC-1.1.3|UC-1.1.3 Integrate a local application with an existing system]]
−
**[[USC-1.1.4 | USC-1.1.4 Use the network as the local system]]
+
**[[UC-1.1.4|UC-1.1.4 Use the network as the local system]]
  
−
*[[USC-1.2 | USC-1.2 Implement a system of intellectual control]]
+
*[[UC-1.2|UC-1.2 Implement a system of intellectual control]]
−
**[[USC-1.2.1 | USC-1.2.1 Implement an arrangement policy]]
+
**[[UC-1.2.1|UC-1.2.1 Implement an arrangement policy]]
−
**[[USC-1.2.2 | USC-1.2.2 Implement a descriptive standard]]
+
**[[UC-1.2.2|UC-1.2.2 Implement a descriptive standard]]
  
  
−
[[USC-2 | '''USC-2 Add / edit content''']]
+
[[UC-2|'''UC-2 Add / edit content''']]
−
*[[USC-2.1 | USC-2.1 Appraise materials]]
+
*[[UC-2.1|UC-2.1 Appraise materials]]
  
−
*[[USC-2.2 | USC-2.2 Acquire archival materials]]
+
*[[UC-2.2|UC-2.2 Acquire archival materials]]
  
−
*[[USC-2.3 | USC-2.3 Store archival materials]]
+
*[[UC-2.3|UC-2.3 Store archival materials]]
  
−
*[[USC-2.4 | USC-2.4 Preserve archival materials]]
+
*[[UC-2.4|UC-2.4 Preserve archival materials]]
  
−
*[[USC-2.5 | USC-2.5 Describe archival materials]]
+
*[[UC-2.5|UC-2.5 Describe archival materials]]
  
−
**[[USC-2.5.1 | USC-2.5.1 Assign a unique identifier to a unit of archival material]]
+
**[[UC-2.5.1|UC-2.5.1 Assign a unique identifier to a unit of archival material]]
−
**[[USC-2.5.2 | USC-2.5.2 Assign a title to a unit of archival material]]
+
**[[UC-2.5.2|UC-2.5.2 Assign a title to a unit of archival material]]
−
**[[USC-2.5.3 | USC-2.5.3 Assign a unit to the hierarchy of arrangement]]
+
**[[UC-2.5.3|UC-2.5.3 Assign a unit to the hierarchy of arrangement]]
−
**[[USC-2.5.4 | USC-2.5.4 Record the dates of archival materials]]
+
**[[UC-2.5.4|UC-2.5.4 Record the dates of archival materials]]
−
**[[USC-2.5.5 | USC-2.5.5 Record the extent of archival materials]]
+
**[[UC-2.5.5|UC-2.5.5 Record the extent of archival materials]]
−
**[[USC-2.5.6 | USC-2.5.6 Identify the creator of archival materials]]
+
**[[UC-2.5.6|UC-2.5.6 Identify the creator of archival materials]]
−
**[[USC-2.5.7 | USC-2.5.7 Describe the history of custody of archival materials]]
+
**[[UC-2.5.7|UC-2.5.7 Describe the history of custody of archival materials]]
−
**[[USC-2.5.8 | USC-2.5.8 Describe the conditions of access and use of archival materials]]
+
**[[UC-2.5.8|UC-2.5.8 Describe the conditions of access and use of archival materials]]
−
**[[USC-2.5.9 | USC-2.5.9 Indicate the existence of related archival materials]]
+
**[[UC-2.5.9|UC-2.5.9 Indicate the existence of related archival materials]]
 
 
−
*[[USC-2.6 | USC-2.6 Describe actors that interact with archival materials]]
+
*[[UC-2.6|UC-2.6 Describe actors that interact with archival materials]]
−
**[[USC-2.6.1 | USC-2.6.1 Identify actors]]
+
**[[UC-2.6.1|UC-2.6.1 Identify actors]]
−
**[[USC-2.6.2 | USC-2.6.2 Describe the nature, context, and activities of actors]]
+
**[[UC-2.6.2|UC-2.6.2 Describe the nature, context, and activities of actors]]
−
**[[USC-2.6.3 | USC-2.6.3 Indicate relationships between actors]]
+
**[[UC-2.6.3|UC-2.6.3 Indicate relationships between actors]]
−
**[[USC-2.6.4 | USC-2.6.4 Identify related archival materials]]
+
**[[UC-2.6.4|UC-2.6.4 Identify related archival materials]]
 
 
−
*[[USC-2.7 | USC-2.7 Describe institutions that have custody of archival materials]]
+
*[[UC-2.7|UC-2.7 Describe institutions that have custody of archival materials]]
  
−
*[[USC-2.8 | USC-2.8 Control description records]]
+
*[[UC-2.8|UC-2.8 Control description records]]
  
−
*[[USC-2.9 | USC-2.9 Assign access points to descriptions]]
+
*[[UC-2.9|UC-2.9 Assign access points to descriptions]]
  
−
*[[USC-2.10 | USC-2.10 Administer access to archival materials]]
+
*[[UC-2.10|UC-2.10 Administer access to archival materials]]
 
 
−
*[[USC-2.11 | USC-2.11 Promote archival materials]]
+
*[[UC-2.11|UC-2.11 Promote archival materials]]
  
  
−
[[USC-3 | '''USC-3 Translate content''']]
+
[[UC-3|'''UC-3 Translate content''']]
  
  
−
[[USC-4 | '''USC-4 Access content''']]
+
[[UC-4|'''UC-4 Access content''']]
  
  
−
[[USC-5 | '''USC-5 Import / export content''']]
+
[[UC-5|'''UC-5 Import / export content''']]
  
  
−
[[USC-6 | '''USC-6 Administer the system''']]
+
[[UC-6|'''UC-6 Administer the system''']]

Latest revision as of 12:51, 11 July 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

Purpose

Use cases describe interactions with an application from the end-users' point of view in a variety of what if scenarios. Use cases:

  • Test the application's current functionality.
  • Identify issues that need to be addressed in future releases.
  • Support development of user-end documentation.


Organization

Use cases are clustered around the same broad categories as the functional requirements. Like the latter, use cases are organized hierarchy with high-level scenarios broken down into more specific tests (sub- and sub-sub-cases). To facilitate cross-references and links, each case has been assigned an alpha-numeric code: the alpha prefix designates its type (UC = use case), the number establishes its position in the hierarchy. Six main use cases have been identified:


Use case actors

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.


Information

Each use case includes some or all of the following information:

Summary

  • Use case number: UC-x.x.x, unique tracking number assigned to the use case.
  • Use case name: descriptive name assigned to requirement.
  • Context (parent requirements): links to higher-level cases, if applicable.
  • Sub-requirements: links to lower-level cases, if applicable.
  • Overview: brief description of the scenario.
  • Actors: the main actor(s) 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 describing the scenario as leading to a successful outcome.
  • Exceptions / variations: other possible variations, including unsuccessful outcomes ("Scenario B", "Scenario C" etc).


Requirements

  • Functional requirements: links to associated functional requirements (FR-x).
  • Metadata requirements: links to associated metadata requirements (MR-x).
  • Technical requirements: links to associated technical requirements (TR-x).


Documentation

  • Diagrams: work-flow or other diagrams illustrating the scenario.
  • User Manual: links to the User manual sections that provide step-by-step instructions for activities relating to the scenario.


Index of use cases

The following is the full index to use cases identified to date.


UC-1 Implement a system of control


UC-2 Add / edit content


UC-3 Translate content


UC-4 Access content


UC-5 Import / export content


UC-6 Administer the system

Retrieved from "https://wiki.ica-atom.org/index.php?title=Use_cases&oldid=4427"