<Project Name>

Supplementary Specifications

 

Version <1.0>

 

[Note: The following template is provided for use with the Rational Unified Process. Text enclosed in square brackets and displayed in blue italics (style=InfoBlue) is included to provide guidance to the author and should be deleted before publishing the document. A paragraph entered following this style will automatically be set to normal (style=Body Text).]

 

 

 


Revision History

Date

Version

Description

Author

<dd/mmm/yy>

<x.x>

<details>

<name>

 

 

 

 

 

 

 

 

 

 

 

 

 


Table of Contents

1.       Introduction         

1.1     Purpose     

1.2     Scope     

1.3     Definitions, Acronyms and Abbreviations     

1.4     References     

1.5     Overview     

2.       Functionality     

2.1     <Functional Requirement One>     

3.       Usability

3.1     <Usability Requirement One>     

4.       Reliability

4.1     <Reliability Requirement One>     

5.       Performance       

5.1     <Performance Requirement One>     

6.       Supportability    

6.1     <Supportability Requirement One>     

7.       Design Constraints   

7.1     <Design Constraint One>     

8.        Additional Systems Engineering Considerations               

8.1     Physical Requirements     

8.2     Environmental Requirements     

8.3     Other Product Assurance Requirements     

8..3.x   <Category> 

8.4     Human-related Requirements 

8.5     Logistics Requirements  

9.       Online User Documentation and Help System Requirements

10.       Purchased Components 

11.            Interfaces               

11.1     User Interfaces     

11.2     Hardware Interfaces     

11.3     Software Interfaces     

11.4     Communications Interfaces     

12.            Licensing Requirements               

13.            Legal, Copyright and Other Notices               

14.            Applicable Standards               


Supplementary Specifications

1.                  Introduction

[The introduction of the Supplementary Specifications should provide an overview of the entire document. It should include the purpose, scope, definitions, acronyms, abbreviations, references, and overview of these Supplementary Specifications.

The Supplementary Specifications captures the system requirements that are not readily captured in the use cases of the use-case model. Such requirements include:

·         Legal and regulatory requirements, including application standards.

·         Quality attributes of the system to be built, including usability, reliability, performance, and supportability requirements.

·         Other requirements such as operating systems and environments, compatibility requirements, and design constraints.]

1.1               Purpose

[Specify the purpose of these Supplementary Specifications.]

1.2               Scope

[A brief description of the scope of these Supplementary Specifications; what Project(s) it is associated with, and anything else that is affected or influenced by this document.]

1.3               Definitions, Acronyms and Abbreviations

[This subsection should provide the definitions of all terms, acronyms, and abbreviations required to properly interpret the Supplementary Specifications.  This information may be provided by reference to the project Glossary.]

1.4               References

[This subsection should provide a complete list of all documents referenced elsewhere in the Supplementary Specifications.  Each document should be identified by title, report number (if applicable), date, and publishing organization.  Specify the sources from which the references can be obtained. This information may be provided by reference to an appendix or to another document.]

1.5               Overview

[This subsection should describe what the rest of the Supplementary Specifications contains and explain how the document is organized.]

2.                  Functionality

[This section describes any additional functional requirements of the system expressed in natural-language form.]

2.1               <Functional Requirement One>

[The requirement description.]

3.                  Usability

[This section should include all of those requirements that affect usability. Examples follow:

·         specify the required training time for a normal users and power users to become productive at particular operations

·         specify measurable task times for typical tasks, or

·         specify requirements to conform to common usability standards, for example, IBM?s CUA standards or Microsoft?s GUI standards]

3.1               <Usability Requirement One>

The requirement description.

4.                  Reliability

[Requirements for reliability of the system should be specified here. Suggestions are as follows:

·         Availability ? specify percentage of time available ( xx.xx%), hours of use, maintenance access, degraded mode operations, etc.

·         Mean Time Between Failures (MTBF) ? this is usually specified in hours but it could also be specified in terms of days, months or years.

·         Mean Time To Repair (MTTR) ? how long is the system allowed to be out of operation after it has failed?

·          Accuracy ? specify precision (resolution) and accuracy (by some known standard) that is required in the systems output.

·         Maximum bugs or defect rate ? usually expressed in terms of bugs/KLOC (thousands of lines of code), or bugs/function-point.

·         Bugs or defect rate ? categorized in terms of minor, significant, and critical bugs: the requirement(s) must define what is meant by a ?critical? bug (e.g., complete loss of data or complete inability to use certain parts of the functionality of the system).]

4.1               <Reliability Requirement One>

[The requirement description.]

5.                  Performance

[The performance characteristics of the system should be outlined in this section. Include specific response times. Where applicable, reference related Use Cases by name. In general, all required capabilities, whether described in use-case form or simply by text, should be associated with some performance statement (describing how well the system should provide the capability or function). It is better to keep those statements of performance in proximity to the affected capability (in the 'special requirements' part of a use-case description, for example). Here, you can keep statements of requirements that need to be tested, but which are not aligned with specific capability.

·         Response time for a transaction (average, maximum)

·         Throughput (e.g., transactions per second)

·         Capacity (e.g., the number of customers or transactions the system can accommodate)

·         Degradation modes (what is the acceptable mode of operation when the system has been degraded in some manner)

·         Resource utilization: memory, disk, communications, etc.]

5.1               <Performance Requirement One>

[The requirement description.]

6.                  Supportability

[This section indicates any requirements that will enhance the supportability or maintainability of the system being built, including coding standards, naming conventions, class libraries, maintenance access, maintenance utilities.]

6.1               <Supportability Requirement One>

[The requirement description.]

7.                  Design Constraints

[This section should indicate any design constraints on the system being built. Design constraints represent design decisions that have been mandated and must be adhered to.  Examples include software languages, software process requirements, prescribed use of developmental tools, architectural and design constraints, purchased components, class libraries, etc.]

7.1               <Design Constraint One>

[The requirement description.]

8.         Additional Systems Engineering Considerations

[Systems engineering potentially requires other types of requirements to be addressed:]

8.1       Physical Requirements

[For example, weight, size, power,...]

8.2       Environmental Requirements

[For example, moisture, contaminant, thermal, electrical, mechanical,...]

8.3       Other Product Assurance Requirements

8.3.x     <Category>

[For example, safety, security, other quality factors (e.g. survivability)]

8.4       Human-related Requirements

[Describe the requirements imposed on the system in support of the people who will use and support the system: examples include training capabilities - equipment and materials to be included for training - maintenance capabilities, ergonomic considerations not covered by interface descriptions and standards.]

8.5       Logistics Requirements

[Describe the requirements imposed on the system because of logistics considerations - including maintenance, support, transportation, supply, accommodation of existing systems.]

9.                  Online User Documentation and Help System Requirements

[Describes the requirements, if any, for on-line user documentation, help systems, help about notices, etc.]

10.              Purchased Components

[This section describes any purchased components to be used with the system, any applicable licensing or usage restrictions, and any associated compatibility/interoperability or interface standards.]

11.             Interfaces

[This section defines the interfaces that must be supported by the system. It should contain adequate specificity, protocols, ports and logical addresses, etc., so that the system can be developed and verified against the interface requirements. Any requirements to be imposed on interfaces internal to the system should also be described. These arise, for example, when the system design is constrained to use existing hardware or software components internally.]

11.1            User Interfaces

[Describe the user interfaces that are to be implemented by the system.]

11.2            Hardware Interfaces

[This section defines any hardware interfaces that are to be supported by the system, including logical structure, physical addresses, expected behavior, etc.]

11.3            Software Interfaces

[This section describes software interfaces to be supported by the system, in terms of operations and signals supported (and for which support is required), protocols and data characteristics.]

11.4            Communications Interfaces

[Describe any communications interfaces to other systems or devices such as local area networks, etc.]

12.             Licensing Requirements

[Defines any licensing enforcement requirements or other usage restriction requirements which are to be exhibited by the system.]

13.             Legal, Copyright and Other Notices

[This section describes any necessary legal disclaimers, warranties, copyright notices, patent notice, wordmark, trademark or logo compliance issues for the system.]

14.             Applicable Standards

[This section describes by reference any applicable standards and the specific sections of any such standards that apply to the system being described. For example, this could include legal, quality and regulatory standards, industry standards for usability, interoperability, internationalization, operating system compliance, etc.]