Difference between revisions of "Proj-2013-2014-StartAIR-2"

From air
Jump to navigation Jump to search
Line 41: Line 41:
 
=2. General description=
 
=2. General description=
 
==2.1 Product perspective==
 
==2.1 Product perspective==
  +
  +
<gallery>
  +
Image:diagrammeClasseGL.png|General UML
  +
Image:Architecture.png|General Architectur
  +
</gallery>
  +
 
==2.2 Product functions==
 
==2.2 Product functions==
 
==2.3 User characteristics==
 
==2.3 User characteristics==

Revision as of 10:04, 10 March 2014

Progress of the project

UML

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 the 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

  • The software we are developping is a plugin for Microsoft Flight Simulator
  • It is an Open Source software
  • It only run on Windows XP/7/8

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

  • Platform constraints:
    • Must run on Windows XP/7/8/8.1
    • Acces to an USB hub or a local network
  • Un server ne peut être lancé qu'une seul fois
  • Un client doit être lancé par machine si elle n’a pas le server
  • Un client procède une ou plusieurs configurations mais une seul ne peut être lancée avant les services
  • Un client ne doit être lancé sur si un server est lancé.

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:

6. Index