Difference between revisions of "Functional requirements"

From ICA-AtoM
Jump to navigation Jump to search
Line 10: Line 10:
  
  
Functional requirements are organized hierarchically 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:
+
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:
*[[#Establish intellectual and administrative control over archival materials | Establish intellectual and administrative control over archival materials]]: support arrangement and description of archival holdings).
+
#[[#FR-1 | Establish intellectual and administrative control over archival materials]]
*[[#Search and use descriptions | Search and use descriptions]]: support search and use of archival materials by researchers.
+
#[[#FR-2 | Provide an interface that supports user interaction with the system (create, read, update, delete, search]]
  
  
 
Each functional requirement includes the following information:
 
Each functional requirement includes the following information:
*Requirement number (for cross-reference purposes).
+
 
*Requirement name.
+
{| border="1" cellpadding="2"
*Requirement specification (system must do X).
+
 
*Requirement quotation (which section of which standard requires that the system do X?).
+
|- valign="top" align="left" style="background:#00008B; color:white"
*Associated metadata requirements (what data must the system capture to do X?).
+
!width="250" | Requirement number
*Associated quality requirements (what features must the system have to do X well from a user / interface point of view?).
+
!width="700" | FR-x.x.x (unique tracking number assigned to requirement)
*Associated technical requirements (what system architecture, programming rules, hardware / software configurations must the system implement to do X?)
+
 
*ICA-AtoM implementation (how does ICA-AtoM implement X?).
+
|- valign="top" align="left"
*Known issues (problems with current implementation / functionality).
+
| style="background:silver" | Requirement name
*''User Manual'' sections (links to step-by-step user instructions for doing X).
+
| Descriptive name assigned to requirement.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
| Brief description of requirement: system must do X.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Sub-requirements
 +
| If the requirement is broken down into sub-requirements, provides links to these.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
| Links to standards or other documents: why must the system be able to do X?
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated metadata requirements
 +
| Links to functional requirements: what data must the system capture in order to be able to do X?
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
| Links to quality requirements: what design and interface features must the system have to do X well?
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
| Links to technical requirements: what system architecture, hardware / software configurations, and programming rules must the system implement to do X?
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
| Brief description of how ICA-AtoM implements X.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
| Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
| Links to the User manual sections that provide step-by-step instructions for doing X.
 +
 
 +
|}
  
  

Revision as of 14:52, 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

Implement descriptive standards

Create and control description records

Describe archival materials

Describe actors

Describe archival institutions

Template

Requirement number MR-x
Requirement name Name
Requirement specification

The system must:

  • requirement1
  • requirement2
Requirement quotation
  • link to ISAD(G).
  • link to ISAAR(CPF).
  • link to ISIAH.
  • link to ISDF.
  • link to OSARIS.
Associated metadata requirements
  • link to metadata requirement.
Associated quality requirements
  • link to quality requirement.
Associated technical requirements
  • link to technical requirement.
ICA-AtoM implementation
  • discuss how ICA-AtoM implements requirement.
Known issues
  • discuss how any known problems with ICA-AtoM's current implementation / functionality.
User Manual sections
  • link to User Manual pages.