Latest revision as of 10:55, 25 January 2017

The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.

Read first:

Document History
	Version	Date	Authors	Description	Validator	Validation Date
	0.1.0	TBC	TBC	TBC	TBC	TBC

1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for project StartAir Safe. In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product

1.3 Definitions, acronyms and abbreviations

1.4 References

The main page of the project: Proj-2013-2014-StartAIR-2

1.5 Overview of the remainder of the document

2. General description

2.1 Product perspective

2.2 Product functions

2.3 User characteristics

2.4 General constraints

2.5 Assumptions and dependencies

3.Specific requirements, covering functional, non-functional and interface requirements

document external interfaces,
describe system functionality and performance
specify logical database requirements,
design constraints,
emergent system properties and quality characteristics.

3.1 Requirement X.Y.Z (in Structured Natural Language)

Function:

Description:

Inputs:

Source:

Outputs:

Destination:

Action:

Natural language sentences (with MUST, MAY, SHALL)
Graphical Notations : UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
Mathematical Notations
Tabular notations for several (condition --> action) tuples

Non functional requirements:

Pre-condition:

Post-condition:

Side-effects:

4. Product evolution

5. Appendices

5.1. SRS structure

The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

References:

@@ Line 1: / Line 1: @@
 The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.
+'''Read first:'''
+* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
+* http://en.wikipedia.org/wiki/Software_requirements_specification
+* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]
  {|class="wikitable alternance"
@@ Line 15: / Line 20: @@
  !scope="row" |
  | 0.1.0
- | 2013/01/21
+ | TBC
+ | TBC
- | Mame Daba Diouf
  | TBC
  | TBC
@@ Line 26: / Line 31: @@
 =1.   Introduction=
 ==1.1   Purpose of the requirements document==
+This Software Requirements Specification (SRS) identifies the requirements for project StartAir Safe.
+In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities offered and the problems that the system solves.
-This document includes the descriptions of the software services and constraints that should be respected during its development.
-It is intended to client engineers and managers, software developers, software users and contractors so that it allows them to understand and validate what the software will do.
 ==1.2   Scope of the product==
-The name of the product is BMS.
-		BMS:
-*	Will control temperature, ventilation, lighting in a building, report residents’ preferences
-*	Will NOT include security monitor.
 ==1.3   Definitions, acronyms and abbreviations==
-* BMS = Building Mangaement System
-* HVAC = Heating Ventilation Air Conditionning
 ==1.4   References==
+*The main page of the project: [[Proj-2013-2014-StartAIR-2]]
-IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998
 ==1.5   Overview of the remainder of the document==
-The rest of the document contains, along these lines :
--	The overall descriptions
--	The specific requirements and
--	Supporting information
 =2.   General description=
 ==2.1   Product perspective==
 ==2.2   Product functions==
-The major functions that the BMS will perform are :
-*	HVAC software programs
-*	Panel with LCD display
-*	Weekly time program (optional)
-*	Panel with internal temperature/pollution sensor (optional)
-[[File:1.png]]
-Here is an example of an usage of the BMS:
-[[File:2.png]]
-	Action Flow:
-- The panel displays the current temperature
-- The user enters with the new temperature, 20 for example
--The system sends the temperature to the sensor
-- The system saves the temperature in the server
--The panel displays the new temperature.
 ==2.3   User characteristics==
-The users (User and SuperUser) are expected to be able to use keypads in order to identify themselves and LCD panel controls.
-The SuperUser is expected to be the master of the system and will be more powerful than the User.
 ==2.4   General constraints==
-The use of the BMS is directly linked to the activities which are done by the occupiers of the building.
-The system will not include security monitor such as burglar's prevention but it will allow users to go inside the building by identifying themselves with the right codes.
 ==2.5   Assumptions and dependencies==
 =3.Specific requirements, covering functional, non-functional and interface requirements=
@@ Line 108: / Line 55: @@
 ==3.1 Requirement X.Y.Z (in Structured Natural Language)==
-[[File:UseCasesDiagram.png]]
 '''Function''':
-The system allows the user to control:
-*The temperature;
-*The luminosity;
-*The quality of the air.
-   To store the preferences user.
-   Count the number of people in the house.
 '''Description''':
 '''Inputs''':
-   The data the user;
-   The data of the sensors:
-      • Sensor of temperature;
-      •	Sensor the luminosity;
-      •	Sensor the quality of the air.
 '''Source''':
-   The user;
-   The several sensors.
 '''Outputs''':
-   Visualization of data on the screen of the tablet.
-   LED access indicator in the home.
 '''Destination''':
@@ Line 162: / Line 84: @@
 =5. Appendices=
+==5.1. SRS structure==
+The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.
+'''References:'''
+* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
+* http://en.wikipedia.org/wiki/Software_requirements_specification
+* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]
 =6. Index=

Difference between revisions of "SRS"