Supplementary specification

<Company Name>

<Project Name>Supplementary Specification

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).]

[To customize automatic fields in Microsoft Word (which display a gray background when selected), select File>Properties and replace the Title, Subject and Company fields with the appropriate information for this document. After closing the dialog, automatic fields may be updated throughout the document by selecting Edit>Select All (or Ctrl-A) and pressing F9, or simply click on the field and press F9. This must be done separately for Headers and Footers. Alt-F9 will toggle between displaying the field names and the field contents. See Word help for more information on working with fields.]

<Project Name> Version: <1.0>Supplementary Specification Date: <dd/mmm/yy><document identifier>

Revision HistoryDate Version Description Author

<dd/mmm/yy> <x.x> <details> <name>

Confidential <Company Name>, 2023 Page 2


Table of Contents

1. Introduction 3

1.1 Purpose 31.2 Scope 31.3 Definitions, Acronyms, and Abbreviations 31.4 References 31.5 Overview 3

2. Functionality 3

2.1 <Functional Requirement One> 3

3. Usability 3

3.1 <Usability Requirement One> 3

4. Reliability 3

4.1 <Reliability Requirement One> 3

5. Performance 3

5.1 <Performance Requirement One> 3

6. Supportability 3

6.1 <Supportability Requirement One> 3

7. Design Constraints 3

7.1 <Design Constraint One> 3

8. Online User Documentation and Help System Requirements 3

9. Purchased Components 3

10. Interfaces 3

10.1 User Interfaces 310.2 Hardware Interfaces 310.3 Software Interfaces 310.4 Communications Interfaces 3

11. Licensing Requirements 3

12. Legal, Copyright, and Other Notices 3

13. Applicable Standards 3



Supplementary Specification 1. Introduction

[The introduction of the Supplementary Specification provides an overview of the entire document. It includes the purpose, scope, definitions, acronyms, abbreviations, references, and overview of this Supplementary Specification.

The Supplementary Specification 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 this Supplementary Specification.]

1.2 Scope

[A brief description of the scope of this Supplementary Specification; 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 provides the definitions of all terms, acronyms, and abbreviations required to properly interpret the Supplementary Specification. This information may be provided by reference to the project’s Glossary.]

1.4 References

[This subsection provides a complete list of all documents referenced elsewhere in the Supplementary Specification. Identify each document 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 describes what the rest of the Supplementary Specification contains and explains how the document is organized.]

2. Functionality[This part of the section presents the complete use case model for the system

The following subsections describe the functional requirements of the system for those requirements, which are expressed in the natural language style. For many applications, this may constitute the bulk of the SRS Package and thought should be given to the organization of this section. This section is typically organized by feature, but alternative organization methods, for example organization by user or organization by subsystem, may also be appropriate. Functional requirements may include feature sets, capabilities, and security.

Where application development tools, such as requirements tools, modeling tools, and so on, are employed to capture the functionality, this section document will refer to the availability of that data, indicating the location and name of the tool used to capture the data.]



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, and the like.

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; for example, complete loss of data or complete inability to use certain parts of the functionality of the system.]

4.1 <Reliability Requirement One>


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.

Response time for a transaction(average, maximum)

Throughput (for example, transactions per second)

Capacity (for example, 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 use: memory, disk, communications, and so forth]



5.1 <Performance Requirement One>


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>


7. Design Constraints[This section needs to 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, and so on.]

7.1 <Design Constraint One>


8. Online User Documentation and Help System Requirements[Describes the requirements, if any, for on-line user documentation, help systems, help about notices, and so on.]

9. 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.]

10. Interfaces[This section defines the interfaces that must be supported by the application. It should contain adequate specificity, protocols, ports and logical addresses, and so forth, so that the software can be developed and verified against the interface requirements.]

10.1 User Interfaces

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

10.2 Hardware Interfaces

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

10.3 Software Interfaces

[This section describes software interfaces to other components of the software system. These may be purchased components, components reused from another application or components being developed for subsystems outside of the scope of this SRS, but with which this software application must interact.]

10.4 Communications Interfaces

[Describe any communications interfaces to other systems or devices such as local area networks, remote serial devices, and so on.]



11. Licensing Requirements[Defines any licensing enforcement requirements or other usage restriction requirements that are to be exhibited by the software.]

12. 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 software.]

13. 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, and so forth.]

APPENDIX A – Use-case Specification Section[The following template is provided for a Use-Case Specification, which contains the textual properties of the use case. The template should be used for each identified use-case]

1. Use-Case Name

1.1 Brief Description

[The description briefly conveys the role and purpose of the use case. A single paragraph will suffice for this description.]

2. Flow of Events

2.1 Basic Flow

[This use case starts when the actor does something. An actor always initiates use cases. The use case describes what the actor does and what the system does in response. It is phrased in the form of a dialog between the actor and the system.

The use case describes what happens inside the system, but not how or why. If information is exchanged, be specific about what is passed back and forth. For example, it is not very illuminating to say that the actor enters customer information. It is better to say the actor enters the customer’s name and address. A Glossary of Terms is often useful to keep the complexity of the use case manageableyou may want to define things like customer information there to keep the use case from drowning in details.

Simple alternatives may be presented within the text of the use case. If it only takes a few sentences to describe what happens when there is an alternative, do it directly within the Flow of Events section. If the alternative flow is more complex, use a separate section to describe it. For example, an Alternative Flow subsection explains how to describe more complex alternatives.

A picture is sometimes worth a thousand words, though there is no substitute for clean, clear prose. If it improves clarity, feel free to paste graphical depictions of user interfaces, process flows or other figures into the use case. If a flow chart is useful to present a complex decision process, by all means use it! Similarly for state-dependent behavior, a state-transition diagram often clarifies the behavior of a system better than pages upon pages of text. Use the right presentation medium for your problem, but be wary of using terminology, notations or figures that your audience may not understand. Remember that your purpose is to clarify, not obscure.]



2.2 Alternative Flows

2.2.1 < First Alternative Flow >

[More complex alternatives are described in a separate section, referred to in the Basic Flow subsection of Flow of Events section. Think of the Alternative Flow subsections like alternative behavior each alternative flow represents alternative behavior usually due to exceptions that occur in the main flow. They may be as long as necessary to describe the events associated with the alternative behavior. When an alternative flow ends, the events of the main flow of events are resumed unless otherwise stated.]

2.2.1.1 < An Alternative Subflow >

[Alternative flows may, in turn, be divided into subsections if it improves clarity.]

2.2.2 < Second Alternative Flow >

[There may be, and most likely will be, a number of alternative flows in a use case. Keep each alternative flow separate to improve clarity. Using alternative flows improves the readability of the use case, as well as preventing use cases from being decomposed into hierarchies of use cases. Keep in mind that use cases are just textual descriptions, and their main purpose is to document the behavior of a system in a clear, concise, and understandable way.]

3. Special Requirements[A special requirement is typically a nonfunctional requirement that is specific to a use case, but is not easily or naturally specified in the text of the use case’s event flow. Examples of special requirements include legal and regulatory requirements, application standards, and quality attributes of the system to be built including usability, reliability, performance or supportability requirements. Additionally, other requirementssuch as operating systems and environments, compatibility requirements, and design constraintsshould be captured in this section.]

3.1 < First Special Requirement >

4. Preconditions[A precondition of a use case is the state of the system that must be present prior to a use case being performed.]

4.1 < Precondition One >

5. Postconditions[A postcondition of a use case is a list of possible states the system can be in immediately after a use case has finished.]

5.1 < Postcondition One >

6. Extension Points[Extension points of the use case.]

6.1 <Name of Extension Point>

[Definition of the location of the extension point in the flow of events.]


Documents

Supplementary specification