Difference between revisions of "Functional requirements"

Revision as of 20:00, 25 January 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 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: support arrangement and description of archival holdings).
Search and use descriptions: support search and use of archival materials by researchers.

Each functional requirement includes the following information:

Requirement number (for cross-reference purposes).
Requirement name.
Requirement specification (system must do X).
Requirement quotation (which section of which standard requires that the system do X?).
Associated metadata requirements (what data must the system capture to do X?).
Associated quality requirements (what features must the system have to do X well from a user / interface point of view?).
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?).
Known issues (problems with current implementation / functionality).
User Manual sections (links to step-by-step user 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	1.1 Implement a system of control 1.2 Implement descriptive standards 1.3 Create and control description records 1.4 Describe archival materials 1.5 Describe actors 1.6 Describe archival institutions

---

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.

@@ Line 10: / Line 10: @@
-Functional requirements have been organized around the core functions of repositories holding archival material. ICA-AtoM currently focuses on two functions:
+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:
 *[[#Establish intellectual and administrative control over archival materials | Establish intellectual and administrative control over archival materials]]: support arrangement and description of archival holdings).
 *[[#Search and use descriptions | Search and use descriptions]]: support search and use of archival materials by researchers.
-A number of functions remain outside the scope of the current version or are only partially supported. Inclusion of these functions serves primarily as a placeholder for requirements for future development of the system.
-*[[#Acquire archival materials | Acquire archival materials]]: accession material, transfer / capture / ingest material, track donors, appraise for acquisition and selection, appraise for monetary evaluation.
-*[[#Manage physical control | Manage physical control]]: store and retrieve archival material, manage storage space.
-*[[#Preserve archival materials | Preserve archival materials]] (implement strategies for long-term preservation of archival material).
-*[[#Administer access | Administer access]]: provide reference service, deliver access to archival material.
-*[[#Perform outreach and education | Perform outreach and education]]: exhibit archival materials, promote holdings, promote repositories, promote the archival profession, educate users.
 Each functional requirement includes the following information:
+*Requirement number (for cross-reference purposes).
 *Requirement name.
 *Requirement specification (system must do X).
 *Requirement quotation (which section of which standard requires that the system do X?).
-*Associated metadata requirements (what fields must the system have to do X?).
+*Associated metadata requirements (what data must the system capture to do X?).
-*Associated usability requirements (what features msut the system have to do X well from a user / interface point of view?).
+*Associated quality requirements (what features must the system have to do X well from a user / interface point of view?).
+*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?).
-*Associated ''User Manual'' sections (links to step-by-step instructions for doing X).
+*Known issues (problems with current implementation / functionality).
+*''User Manual'' sections (links to step-by-step user instructions for doing X).