Difference between revisions of "Proj-2013-2014-BrasRobot-Handicap-2/SRS"

From air
Jump to navigation Jump to search
Line 43: Line 43:
   
 
==1.4 References==
 
==1.4 References==
[https://www.python.org/ Python]
+
[https://www.python.org/ Python] : For Documentation
   
[http://vython.sourceforge.net/ VPython]
+
[http://vython.sourceforge.net/ VPython] : For Documentation
   
 
==1.5 Overview of the remainder of the document==
 
==1.5 Overview of the remainder of the document==

Revision as of 14:10, 11 April 2014

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


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


1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for the RobotArm - Handicap

1.2 Scope of the product

The purpose of this project is to make a simulator to make possible the robot to reach a destination, espacially a real object :

- One part concerns the embodiment of the GUI and a description of the robot
- A second part concerns the communication with the robot
- A third part concerns the communication with the program of detecting markers with the other group

1.3 Definitions, acronyms and abbreviations

Python : Python is a high-level programming language which supports multiple programming paradigms, including object-oriented, imperative and functional programming

VPython : Vpython is a Python language including a library which allows programmer making a GUI in three dimensions more reachable than other languages

1.4 References

Python : For Documentation

VPython : For Documentation

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