RICM4 2017 2018 - robair2/ SRS

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
 * IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998

=1.  Introduction=

1.1 Purpose of the requirements document
This document is a description of the software. It lays out functional and non-functional requirements, and may include a set of use cases that describe user interactions that the software must provide.

1.2 Scope of the product
This project is integraded into the RICM4 formation at Polytech Grenoble as a part of the software engineering course.

1.5 Overview of the remainder of the document
=2.  General description=

2.3 User characteristics
Everybody can use it. no specific characteristics.

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 for the photo shot
Function: Take a picture after a short delay.

Description: This robot will be able to take pictures either via the driver or users by using the tablet.

Inputs:
 * Touch Pad
 * Web-cam

Source: Web-cam

Outputs:
 * A picture

Destination: RobAir twitter account

Action: RobAir will be able (after a short countdown) to take a picture. This picture could be taken by users or the operator.


 * 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: A Twitter account and an Internet connexion (Wifi).

Pre-condition: Operational robot (RobAir).

Post-condition: The published picture can be seen by anyone on Twitter.

Side-effects: Copyrights and collisions

3.1 Requirement X.Y.Z (in Structured Natural Language)
Function: The aim of the project is to implement a new feature of the existing RobAir robot.

Description: This robot will be able to take pictures and publish them on Twitter with its own account.

Inputs:
 * Touch Pad
 * Web-cam
 * Proximity sensors

Source: Proximity sensors and radars.

Outputs:
 * Touch Pad
 * LEDs
 * Twitter

Destination: RobAir control station.

Action: RobAir will be able (after a short countdown) to take a picture. This picture could be taken by users or the operator. This picture will be published on Twitter with short (personalized) description. For example : "The new update #RobAir"


 * 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: A Twitter account and an Internet connexion (Wifi).

Pre-condition: Operational robot (RobAir).

Post-condition: The published picture can be seen by anyone on Twitter.

Side-effects: Copyrights and collisions

=4. Product evolution=

=5. Appendices= =6. Index=