Difference between revisions of "Functional requirements"
| Line 1: | Line 1: | ||
| − | [[Main Page]] > [[System | + | [[Main Page]] > [[System requirements]] > Functional requirements |
== Purpose == | == Purpose == | ||
| Line 41: | Line 41: | ||
*Brief description of requirement; users of the application must be able to do X, the system must be able to do X. | *Brief description of requirement; users of the application must be able to do X, the system must be able to do X. | ||
| − | ''Context (parent requirements)'' | + | '''Context (parent requirements)''' |
*Links to higher-level requirements, if applicable. | *Links to higher-level requirements, if applicable. | ||
| − | ''Sub-requirements'' | + | '''Sub-requirements''' |
*Links to lower-level requirements, if applicable. | *Links to lower-level requirements, if applicable. | ||
| − | ''Source quotations'' | + | '''Source quotations''' |
*Links to standards or other documents: why must the applicable be able to do X? | *Links to standards or other documents: why must the applicable be able to do X? | ||
| − | ''Associated metadata requirements'' | + | '''Associated metadata requirements''' |
*What data must the application capture in order to be able to do X? | *What data must the application capture in order to be able to do X? | ||
| − | ''Associated quality requirements'' | + | '''Associated quality requirements''' |
*What design and interface features must the application have to do X '''well'''? | *What design and interface features must the application have to do X '''well'''? | ||
| − | ''Associated technical requirements'' | + | '''Associated technical requirements''' |
*What system architecture, hardware / software configurations, and programming rules must the application implement to do X? | *What system architecture, hardware / software configurations, and programming rules must the application implement to do X? | ||
| Line 62: | Line 62: | ||
*Brief description of how ICA-AtoM implements X. | *Brief description of how ICA-AtoM implements X. | ||
| − | ''Known issues'' | + | '''Known issues''' |
*Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases. | *Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases. | ||
| − | ''Use cases'' | + | '''Use cases''' |
*Links to descriptions of user-end scenarios relating to the requirement and how they are handled in ICA-AtoM. | *Links to descriptions of user-end scenarios relating to the requirement and how they are handled in ICA-AtoM. | ||
| − | ''User Manual sections'' | + | '''User Manual sections''' |
*Links to the User manual sections that provide step-by-step instructions for doing X. | *Links to the User manual sections that provide step-by-step instructions for doing X. | ||
| Line 79: | Line 79: | ||
*[[FR-1.1|FR-1.1 Define system scope]] | *[[FR-1.1|FR-1.1 Define system scope]] | ||
| − | **[[FR-1.1.1|FR-1.1.1 | + | **[[FR-1.1.1|FR-1.1.1 Specify data input methods]] |
| − | **[[FR-1.1.2|FR-1.1.2 | + | **[[FR-1.1.2|FR-1.1.2 Specify repositories that will contribute descriptions]] |
| − | **[[FR-1.1.3|FR-1.1.3 | + | **[[FR-1.1.3|FR-1.1.3 Specify languages in which descriptions will be accessible]] |
| − | **[[FR-1.1.4|FR-1.1.4 | + | **[[FR-1.1.4|FR-1.1.4 Specify individuals who will contribute descriptions]] |
*[[FR-1.2 |FR-1.2 Implement a system of intellectual control]] | *[[FR-1.2 |FR-1.2 Implement a system of intellectual control]] | ||
| Line 93: | Line 93: | ||
*[[FR-1.3|FR-1.3 Implement a system of administrative control]] | *[[FR-1.3|FR-1.3 Implement a system of administrative control]] | ||
| − | *[[FR | + | *[[FR-1.4| FR-1.4 Implement a system of physical control]] |
| − | |||
[[FR-2|'''FR-2 Add / edit content''']] | [[FR-2|'''FR-2 Add / edit content''']] | ||
Revision as of 15:16, 10 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 > Functional requirements
Purpose
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).
Organization
Functional requirements are organized hierarchically, with high-level requirements broken down into sub- and sub-sub-requirements. To facilitate cross-references and links, each requirement has been assigned an alpha-numeric code: the alpha prefix designates the type of requirement (FR = functional requirement), the number establishes its position in the hierarchy. Six main functional requirements have been identified:
FR-1 Implement a system of control
Information
Each functional requirement includes some or all of the following information:
Requirement number
- FR-x.x.x, unique tracking number assigned to requirement.
Requirement name
- Descriptive name assigned to requirement.
Specification
- Brief description of requirement; users of the application must be able to do X, the system must be able to do X.
Context (parent requirements)
- Links to higher-level requirements, if applicable.
Sub-requirements
- Links to lower-level requirements, if applicable.
Source quotations
- Links to standards or other documents: why must the applicable be able to do X?
Associated metadata requirements
- What data must the application capture in order to be able to do X?
Associated quality requirements
- What design and interface features must the application have to do X well?
Associated technical requirements
- What system architecture, hardware / software configurations, and programming rules must the application 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.
Use cases
- Links to descriptions of user-end scenarios relating to the requirement and how they are handled in ICA-AtoM.
User Manual sections
- Links to the User manual sections that provide step-by-step instructions for doing X.
Note that most of this detail will only be found at the lower-level requirements. Higher-level requirements will typically only include the requirement name, number, specification, and source quotation, with links to the lower-level sub-requirements.