Difference between revisions of "Functional requirements"

From ICA-AtoM
Jump to navigation Jump to search
Line 1,230: Line 1,230:
  
 
<span id="FR-1.5.1"></span>
 
<span id="FR-1.5.1"></span>
−
== Establish authorized headings for actors (names) ==
+
==== Establish authorized headings for actors (names) ====
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
Line 1,283: Line 1,283:
  
 
<span id="FR-1.5.2"></span>
 
<span id="FR-1.5.2"></span>
−
== Describe the characteristics and activities of actors ==
+
==== Describe the characteristics and activities of actors ====
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
Line 1,336: Line 1,336:
  
 
<span id="FR-1.5.3"></span>
 
<span id="FR-1.5.3"></span>
−
== Identify relationships between actors and track changes over time ==
+
==== Identify relationships between actors and track changes over time ====
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
Line 1,389: Line 1,389:
  
 
<span id="FR-1.5.4"></span>
 
<span id="FR-1.5.4"></span>
−
== Identify archival materials related to actors ==
+
==== Identify archival materials related to actors ====
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
Line 1,442: Line 1,442:
  
 
<span id="FR-1.5.5"></span>
 
<span id="FR-1.5.5"></span>
−
== Identify actors that are also custodians of archival materials ==
+
==== Identify actors that are also custodians of archival materials ====
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
Line 1,522: Line 1,522:
 
|}
 
|}
  
−
<span id="FR-">/<span>
+
---
 +
 
 +
<span id="FR-1.6.1"></span>
 +
==== Template ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | FR-1.6.1
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement name
 +
| Describe the mandate and structure of archival institutions.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
|
 +
The system must be able to:
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
*[[ISAD(G)# | ISAD(G) ]]
 +
*[[ISAAR(CPF)# | ISAAR(CPF) ]]
 +
*[[ISIAH# | ISIAH ]]
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated metadata requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="FR-1.6.2"></span>
 +
==== Describe the holdings of archival institutions ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | FR-1.6.2
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement name
 +
| Describe the holdings of archival institutions.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
|
 +
The system must be able to:
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
*[[ISAD(G)# | ISAD(G) ]]
 +
*[[ISAAR(CPF)# | ISAAR(CPF) ]]
 +
*[[ISIAH# | ISIAH ]]
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated metadata requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="FR-1.6.3"></span>
 +
==== Provide the contact information of archival institutions ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | FR-1.6.3
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement name
 +
| Provide the contact information of archival institutions.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
|
 +
The system must be able to:
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
*[[ISAD(G)# | ISAD(G) ]]
 +
*[[ISAAR(CPF)# | ISAAR(CPF) ]]
 +
*[[ISIAH# | ISIAH ]]
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated metadata requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="FR-1.6.4"></span>
 +
==== Describe the services provided by archival instituions ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | FR-1.6.4
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement name
 +
| Describe the services provided by archival instituions.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
|
 +
The system must be able to:
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
*[[ISAD(G)# | ISAD(G) ]]
 +
*[[ISAAR(CPF)# | ISAAR(CPF) ]]
 +
*[[ISIAH# | ISIAH ]]
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated metadata requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="FR-"></span>
 
== Template ==
 
== Template ==
  

Revision as of 15:57, 1 February 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 > Functional requirements


Functional requirements state what the system must be able to do. The requirements provide:

  • Parameters for designing the system.
  • Criteria for testing the system (used in initial release and future iterations and upgrades).
  • Planning guidelines for developing the system (improve existing or add new functionality).
  • Documentation for standards compliance (link requirements to relevant international or national descriptive standards)
  • A framework for structuring user-end documentation (step-by-step procedures for how to do things in the system).


Functional requirements are organized hierarchically, with core requirements, broken down into sub- and sub-sub-requirements. around the core functions of repositories holding archival material. ICA-AtoM currently focuses on two functions, breaking these down into sub- and sub-sub-requirements:

  1. Establish intellectual and administrative control over archival materials
  2. Provide an interface that supports user interaction with the system (create, read, update, delete, search


Each functional requirement includes the following information:

Requirement number FR-x.x.x (unique tracking number assigned to requirement)
Requirement name Descriptive name assigned to requirement.
Requirement specification Brief description of requirement: system must do X.
Sub-requirements If the requirement is broken down into sub-requirements, provides links to these.
Requirement quotation Links to standards or other documents: why must the system be able to do X?
Associated metadata requirements Links to functional requirements: what data must the system capture in order to be able to do X?
Associated quality requirements Links to quality requirements: what design and interface features must the system have to do X well?
Associated technical requirements Links to technical requirements: what system architecture, hardware / software configurations, and programming rules must the system implement to do X?
ICA-AtoM implementation Brief description of how ICA-AtoM implements X.
Known issues Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases.
User Manual sections Links to the User manual sections that provide step-by-step instructions for doing X.


Establish intellectual and administrative control over archival materials

Requirement number FR-1
Requirement name Establish intellectual and administrative control over archival materials
Requirement specification The system must:
  • Support the arrangement and description of archival materials in order to make them accessible.
Sub-requirements

---

Implement a system of control

Requirement number FR-1.1
Requirement name Implement a system of control.
Requirement specification The system must:
Sub-requirements

---

Support multi-level description

Requirement number FR-1.1.1
Requirement name Support multi-level description.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different levels as the highest level of arrangement and description

Requirement number FR-1.1.2
Requirement name Accommodate different levels as the highest level of arrangement and description.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different systems for assigning reference codes

Requirement number FR-1.1.3
Requirement name Accommodate different systems for assigning reference codes.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Implement descriptive standards

Requirement number FR-1.2
Requirement name Implement descriptive standards.
Requirement specification The system must:
Sub-requirements

Support all ICA standards

Requirement number FR-1.2.1
Requirement name Support all ICA standards.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Integrate with existing national or local standards

Requirement number FR-1.2.2
Requirement name Integrate with existing national or local standards.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different practices for the level of detail required

Requirement number FR-1.2.3
Requirement name Accommodate different practices for the level of detail required.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different practices for the level of detail required

Requirement number FR-1.2.4
Requirement name Separate description of archival materials from description of creators and repositories.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

Create and control description records

Requirement number FR-1.3
Requirement name Create and control descriptions
Requirement specification The system must:
Sub-requirements

---

Accept contributions from multiple repositories

Requirement number FR-1.3.1
Requirement name Accept contributions from multiple repositories.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Assign unique identifiers to descriptions

Requirement number FR-1.3.2
Requirement name Assign unique identifiers to descriptions.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate descriptions of different status (draft, finalized, superseded / obsolete)

Requirement number FR-1.3.3
Requirement name Accommodate descriptions of different status (draft, finalized, superseded / obsolete).
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Prevent unauthorized, creation, alteration or deletion of descriptions

Requirement number FR-1.3.4
Requirement name Prevent unauthorized, creation, alteration or deletion of descriptions.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Track changes to descriptions over time

Requirement number FR-1.3.5
Requirement name Track changes to descriptions over time.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Remove superseded or obsolete descriptions

Requirement number FR-1.3.6
Requirement name Remove superseded or obsolete descriptions.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe archival materials

Requirement number FR-1.4
Requirement name Describe archival materials.
Requirement specification The system must:
Sub-requirements

---

Describe the intellectual and physical characteristics of archival materials in all media and record formats

Requirement number FR-1.4.1
Requirement name Describe the intellectual and physical characteristics of archival materials in all media and record formats.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe the context of archival materials

Requirement number FR-1.4.2
Requirement name Describe the context of archival materials.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe the conditions governing access and use of archival materials

Requirement number FR-1.4.3
Requirement name Describe the conditions governing access and use of archival materials.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Ensure that information at the higher and lower levels of description is consistent

Requirement number FR-1.4.4
Requirement name Ensure that information at the higher and lower levels of description is consistent.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Identify the location of material described

Requirement number FR-1.4.5
Requirement name Identify the location of material described.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Indicate the existence of related materials

Requirement number FR-1.4.6
Requirement name Indicate the existence of related materials.
Requirement specification The system must be able to:
Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe actors

Requirement number FR-1.5
Requirement name Describe actors.
Requirement specification The system must:
Sub-requirements

---

Establish authorized headings for actors (names)

Requirement number FR-1.5.1
Requirement name Establish authorized headings for actors (names)
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe the characteristics and activities of actors

Requirement number FR-1.5.2
Requirement name Describe the characteristics and activities of actors.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Identify relationships between actors and track changes over time

Requirement number FR-1.5.3
Requirement name Identify relationships between actors and track changes over time.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Identify archival materials related to actors

Requirement number FR-1.5.4
Requirement name Identify archival materials related to actors.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Identify actors that are also custodians of archival materials

Requirement number FR-1.5.5
Requirement name Identify actors that are also custodians of archival materials.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe archival institutions

Requirement number FR-1.6
Requirement name Describe archival institutions.
Requirement specification The system must:
Sub-requirements

---

Template

Requirement number FR-1.6.1
Requirement name Describe the mandate and structure of archival institutions.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe the holdings of archival institutions

Requirement number FR-1.6.2
Requirement name Describe the holdings of archival institutions.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Provide the contact information of archival institutions

Requirement number FR-1.6.3
Requirement name Provide the contact information of archival institutions.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Describe the services provided by archival instituions

Requirement number FR-1.6.4
Requirement name Describe the services provided by archival instituions.
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Template

Requirement number FR-x
Requirement name
Requirement specification

The system must be able to:

Requirement quotation
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections
Retrieved from "https://wiki.ica-atom.org/index.php?title=Functional_requirements&oldid=1964"