Proj-2013-2014-Python-STM32F4:SRS: Difference between revisions

From air
Jump to navigation Jump to search
Line 30: Line 30:


==1.2 Scope of the product==
==1.2 Scope of the product==
The project aim to complete the project [[Shedskin]] which is a python-to-C++ compiler. The objective of the project is to compile the C++ code which is generated by the compiler Shedskin to executable code which can be run on the board STM32F4.
The objective of this product is to ...

// TODO: chart to added


==1.3 Definitions, acronyms and abbreviations==
==1.3 Definitions, acronyms and abbreviations==

Revision as of 16:19, 11 February 2014

This document describes the software requirements specification of the project Proj-2013-2014-Python-STM32F4

Document History
Version Date Authors Description Validator Validation Date
0.1.0 10 févr. 2014 TAO Xinxiu, XIA ye SRS TBC TBC


1. Introduction

1.1 Purpose of the requirements document

The purpose of this requirements document is to present the requirements and specifications of the project Proj-2013-2014-Python-STM32F4. The document explains the purpose and functional features of the system, the interfaces details of the system, what the system will do, the constraints under which it must operate.

The intended audiences of this document is the users, the developers and the tutor of the project.

1.2 Scope of the product

The project aim to complete the project Shedskin which is a python-to-C++ compiler. The objective of the project is to compile the C++ code which is generated by the compiler Shedskin to executable code which can be run on the board STM32F4.

// TODO: chart to added

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

  • 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

6. Index