Proj-2014-2015-ESP8266/SRS

From air
Revision as of 13:36, 26 January 2015 by Luc.Libralesso (talk | contribs) (3.Specific requirements, covering functional, non-functional and interface requirements)
Jump to: navigation, search

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 Jan 26 2015 Luc Libralesso - Olivier Soldano TBC TBC TBC


1. Introduction

1.1 Purpose of the requirements document

1.2 Scope of the product

1.3 Definitions, acronyms and abbreviations

1.4 References

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

  • maintenance : scaleable code
  • robust : each command is correctly executed
  • useable : easy to use and get started with
  • ethic : free software and well crafted code (PEP8 tests for instance)
  • space : the memory heap limited on ESP8266 so we need a small executable file

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

Function:

Description:

Inputs:

Source:

Outputs:

Destination:

Action:



Non functional requirements:

Pre-condition:

Post-condition:

Side-effects:

4. Product evolution

5. Appendices

6. Index