|
Introduction
|
|
Document convention
|
Standards and conventions to be followed in the specification
|
|
Intended audience
|
Different readers to whom the specification is addressed and the manner in which
they might use it
|
|
Product scope
|
Summary description including purpose, benefits and goals
|
|
References
|
Other documents and resources related to the specification
|
|
Overall description
|
|
Product perspective
|
Context and origins of the product being specified
|
|
Product functions
|
A bulleted list of major functions included in the design
|
|
User classes
|
Identify the different ways that the various user classes will use the software
|
|
Operating environment
|
Other software components or applications with which the software must co-exist
|
|
Constraints
|
Specific technologies, tools, languages, databases etc. that must be used or avoided.
Hardware directives, policy and regulation impacts
|
|
Assumptions
|
Leave nothing implied. All assumptions must be clearly stated
|
|
External interface requirements
|
|
User interfaces
|
- GUI standards / Style guides
- Screen layout or resolution constraints
- Standard navigation methods e.g. buttons,
shortcuts, etc.
- Error handling standards
|
|
Hardware interfaces
|
Relevant devices and the nature of the interface
|
|
Software interfaces
|
Connections to databases, operating systems, tools, libraries, external components
Data sharing
|
|
Communications interfaces
|
For example, email, internet browsing, network connectivity, communications protocols
|
|
System features
|
|
Description and priority
|
A short description of each feature and its priority ranking
|
|
Stimulus/response
|
User actions or triggers and the system response
|
|
Functional requirements
|
Functional requirements associated with the feature
|
|
Business rules
|
Operating principles governing the feature such as add/delete permissions
|
|
Performance
|
Specific performance requirements related to the feature
|
|
Security
|
User rights relating to the feature
|
|
Test cases
|
Tests to identify errors in the specification of the feature
|
|
Ancillary requirements
|
|
Performance
|
General performance requirements not directly related to features
|
|
Safety
|
Any OHS issues implicated
|
|
Security
|
Data integrity, privacy, prudential issues
|
|
Quality attributes
|
Specific quantitative and verifiable attributes such as ease of use, including relative
weighting
|
|
Documentation
|
Deliverable documentation components
|
|
Appendix
|
|
Glossary
|
List of terms
|
|
Analysis models
|
Data flow diagram, class diagrams, entity relationship diagram, data dictionary
|
|
To do list
|
Items for actioning
|