Proj-2014-2015-SmartClassroom/SRS: Difference between revisions

From air
Jump to navigation Jump to search
 
(17 intermediate revisions by 2 users not shown)
Line 30: Line 30:


=1. Introduction=
=1. Introduction=
== Purpose of the requirements document==
==1.1 Purpose of the requirements document==
This document presents the aim of the project Smart Classroom as well as the functionnal and non-functionnal requirements, risks and quality standards.
This document presents the aim of the project Smart Classroom as well as the functionnal and non-functionnal requirements, risks and quality standards.


==1.2 Cadre du produit==
==1.2 Scope of the product==
This project is integrated at the RICM4 engineering training (Computing Networks and Multimedia Communication) in Polytech'Grenoble school. It will be led by 4 students (2 in the Multimedia option and 2 in the Network option) and will last 7 weeks.
Ce projet est intégré à la formation d'ingénieur RICM4 (Réseaux Informatiques et Communication Multimédia) de l'école Polytech' Grenoble. Il sera mené par une équipe de 4 étudiants (2 en option Multimédia et 2 en option Réseaux) et durera 7 semaines.


==1.3 Définitions, acronymes et abréviations==
==1.3 Definitions, acronyms ans abbrevations==
* '''NFC''' : Near Field Communication (Communication dans un champ proche). Un tag NFC peut être relié à des informations telles qu’une page Web, des réseaux sociaux et toutes sortes d'autres informations en général.
* '''NFC''' : Near Field Communication. A NFC tag can be linked to information such as web page, social networks and all sorts of other information in general.
* '''QCM''' : Questionnaire à choix multiples.
* '''MCQ''' : Multiple-choice Questionnaire
* '''ID''' : Identifiant.
* '''ID''' : Identifier


==1.4 Références==
==1.4 References==
Our work follows on from different projects realised by ENSIMAG students :
Notre travail fait suite aux différents projets réalisés par les élèves de l'ENSIMAG : [http://fablab.ensimag.fr/index.php/Projet_%22SmartClassroom%22 Smart Classroom]<br/>
[http://fablab.ensimag.fr/index.php/Projet_%22SmartClassroom%22 Smart Classroom]<br/>
==1.5 Présentation du restant du document==


==1.5 Overview of the remainder of the document==
=2. Description générale=

L'objectif de ce projet est de concevoir un système d'information innovant pour la classe de demain. Le but de ce projet est de faciliter mais surtout d'automatiser des tâches quotidiennes effectuées en salle de cours. Bien qu'il y ait quatre projets gravitant autour de la classe intelligente et réalisés par des élèves de l'ENSIMAG, notre module doit s'intégrer avec les autres afin d'obtenir une réelle infrastructure innovante.
=2. General description=
The aim of this project is to design a new innovative information system for the future of the classroom, by making easier and especially automating daily tasks. Although there are already four projects linked to the smart classroom and realized by ENSIMAG students, our module has to fit in well with the others in order to obtain a real innovative infrastructure.
==2.1 Product perspective==
==2.1 Product perspective==
Our product has to meet the following need :
Our product has to meet the following need :
Line 69: Line 71:
* Smart Classroom environment allows us to link the tablets to the Moodle server
* Smart Classroom environment allows us to link the tablets to the Moodle server


=3. Specific requirements, covering functional, non-functional and interface requirements=
=3. Exigences spécifiques, exigences fonctionnelles, non fonctionnelles et exigences d'interface=
* document external interfaces,
* document external interfaces,
* describe system functionality and performance
* describe system functionality and performance
Line 76: Line 78:
* emergent system properties and quality characteristics.
* emergent system properties and quality characteristics.


==3.1 Exigence X.Y.Z (en Langage Naturel Structuré)==
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
'''Fonction''': Réalisation et gestion de QCM dans le cadre de la SmartClassroom
'''Function''': Realisation and management of MCQ as part of the SmartClassroom


'''Description''': Notre projet consiste à développer un système qui permette d'une part à un professeur de préparer ses cours et de créer des examens sous forme de QCM et d'autre part à ses élèves de répondre à ces examens. Il faudra également gérer l'identification de chaque élève afin de contrôler les présences de chacun lors des cours
'''Description''': Our project consists in developing a system wich allows a teacher to prepare his lessons and create MCQ on one hand, and on the other hand allows students to answer at these MCQ. We will also have to manage the identification of each student in order to control their presence during the lessons.


'''Inputs''': Tablettes des étudiants et du professeur
'''Inputs''': Students' and teacher's tablets


'''Source''': Tag NFC, écran tactile
'''Source''': NFC tag, touch sreen


'''Outputs''': Identification, réponses aux questions de chaque élève
'''Outputs''': Identification, answers to each student's question


'''Destination''': This projects is designed to be integrated in the environment of a SmartClassroom and is bound for being used by teachers and students.
'''Destination''':
Ce projet est destiné à être intégré au sein de l'environnement d'une Smart Classroom et est à destination des enseignants et des étudiants.


'''Action''':
'''Action''':
Line 96: Line 97:
* Tabular notations for several (condition --> action) tuples <br>
* Tabular notations for several (condition --> action) tuples <br>


Côté enseignant :<br>
Teacher side :<br>
* Has to allow the creation of MCQ
* Doit permettre la création des QCM
* Has to permit the recovery of the results
* Doit permettre la récupération des résultats
* Could sort the results per students / questions / answers
* Pourrait effectuer le tri des résultats en fonctions des élèves/ des questions/ des réponses
* Doit permettre l'identification à l'aide d'un ID personnel ou d'un tag NFC
* Has to allow the identification by the meaning of a personal ID or a NFC tag
* Can access the list of students authenticated at every session
<br>
<br>
Student side :
Côté étudiant :
* Must allow the answer of the MCQ
* Doit permettre de répondre au QCM
* Can give an access to the results
* Peut donner un accès direct au résultat
* Doit permettre d'effectuer des modifications avant envoi du QCM
* Has to allow modifications before sending the MCQ
* Doit permettre l'identification à l'aide d'un ID personnel ou d'un tag NFC
* Has to permit the identification by the meaning of a personal ID or a NFC tag
* The student has to be counted as present when he connects to the course


'''Non functional requirements''':
'''Exigences non-fonctionnelles''':
* Easy to use : no user experience needed
* Facilité d'utilisation : Pas d'expérience utilisateur requise
* Portability : usage on tablet
* Portabilité : Utilisation sur tablette
* Taille : L'application ne dépasse pas quelques Mo
* Size : the size of the application won't be more than few bytes
* Usage : Clear interface and elaborate in order to make the user experience efficient
* Utilisabilté : Interface claire et travaillée, de façon à pourvoir une expérience utilisateur efficace
* Robustesse: L'application doit continuer à fonctionner et surveiller lors d'une panne du réseau
* Resistance : the application have to keep working and watch over during a network failure


'''Pre-condition''':
'''Pre-condition''':
* Côté matériel :
* Equipment side :
::- a tablet has to be available for each student and for the teacher
::- une tablette doit être disponible pour chaque élève et pour le professeur
::- each student must have his own swipe card in order to be identified
::- chaque élève doit être muni d'un badge afin de l'identifier
* Application side :
* Côté application :
::- une connexion WiFi doit être maintenue dans la salle de classe
::- a WiFi connection has to be maintened in the classroom


'''Post-condition''':
'''Post-condition''':
* le professeur est capable de créer des supports pour son cours et des QCM via l'application
* the teacher is able to create documents for his lesson and MCQ via the application
* students are identified via their badges
* les élèves sont identifiés grâce à leur badge


'''Effets secondaires''':
'''Side-effects''':


=4. Evolution du produit=
=4. Product evolution=
Le projet SmartClassroom est basé sur un ensemble de scénarios réalisés par plusieurs groupes, la partie réalisée ici n'étant que l'un d'entre eux.<br>
The SmartClassroom project is based on several scenarios realised by a number of groups. The part described here is just one of them.
Future enhancements of this environment could be proposed and implemented by future groups in charge of developping this classroom.
De futures améliorations de cet environnement pourront être proposées et implémentées par de prochains groupes en charge du développement de cette classe.


=5. Annexes=
=5. Appendices=


=6. Index=
=6. Index=

Latest revision as of 07:10, 8 April 2015

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 Janvier 2015 Romain Barthelemy, Alan Damotte, Marie Darrigol, Anthony Leonard Présentation des exigences du projet Smart Classroom TBC TBC


1. Introduction

1.1 Purpose of the requirements document

This document presents the aim of the project Smart Classroom as well as the functionnal and non-functionnal requirements, risks and quality standards.

1.2 Scope of the product

This project is integrated at the RICM4 engineering training (Computing Networks and Multimedia Communication) in Polytech'Grenoble school. It will be led by 4 students (2 in the Multimedia option and 2 in the Network option) and will last 7 weeks.

1.3 Definitions, acronyms ans abbrevations

  • NFC : Near Field Communication. A NFC tag can be linked to information such as web page, social networks and all sorts of other information in general.
  • MCQ : Multiple-choice Questionnaire
  • ID : Identifier

1.4 References

Our work follows on from different projects realised by ENSIMAG students : Smart Classroom

1.5 Overview of the remainder of the document

2. General description

The aim of this project is to design a new innovative information system for the future of the classroom, by making easier and especially automating daily tasks. Although there are already four projects linked to the smart classroom and realized by ENSIMAG students, our module has to fit in well with the others in order to obtain a real innovative infrastructure.

2.1 Product perspective

Our product has to meet the following need : Students come in class, announce their presence and get settled at their work station. The teacher does the same and accesses his plateform where he can get courses and exams that he has created before. Then, the teacher can submit multiple-choice questionnaire to students. They answer to it individually before submitting their answer to the teacher. After that, he can refer to the results and publish it by theme. The teacher can start again a lesson if he sees that it hasn't been clear enough for his students. Finally, he can reorganize students by working group.

2.2 Product functions

  • Individual and secured idendentification
  • Creation of courses' constituents
  • Reply to the test by the students
  • Results display
  • Reorganisation of the students in working groups depending on their level

2.3 User characteristics

There are two types of users for this product and in two different inputs. The first type of user is the teacher who is able to create, modify, pusblish courses and exams. Then there are the students, who, by means of their working space, answer the quizzes and submit their answers.

2.4 General constraints

  • Application has to work on tablet
  • Stable wifi connection is needed inside the smart classroom

2.5 Assumptions and dependencies

  • No access to extern websites
  • Smart Classroom environment allows us to link the tablets to the Moodle server

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: Realisation and management of MCQ as part of the SmartClassroom

Description: Our project consists in developing a system wich allows a teacher to prepare his lessons and create MCQ on one hand, and on the other hand allows students to answer at these MCQ. We will also have to manage the identification of each student in order to control their presence during the lessons.

Inputs: Students' and teacher's tablets

Source: NFC tag, touch sreen

Outputs: Identification, answers to each student's question

Destination: This projects is designed to be integrated in the environment of a SmartClassroom and is bound for being used by teachers and students.

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

Teacher side :

  • Has to allow the creation of MCQ
  • Has to permit the recovery of the results
  • Could sort the results per students / questions / answers
  • Has to allow the identification by the meaning of a personal ID or a NFC tag
  • Can access the list of students authenticated at every session


Student side :

  • Must allow the answer of the MCQ
  • Can give an access to the results
  • Has to allow modifications before sending the MCQ
  • Has to permit the identification by the meaning of a personal ID or a NFC tag
  • The student has to be counted as present when he connects to the course

Non functional requirements:

  • Easy to use : no user experience needed
  • Portability : usage on tablet
  • Size : the size of the application won't be more than few bytes
  • Usage : Clear interface and elaborate in order to make the user experience efficient
  • Resistance : the application have to keep working and watch over during a network failure

Pre-condition:

  • Equipment side :
- a tablet has to be available for each student and for the teacher
- each student must have his own swipe card in order to be identified
  • Application side :
- a WiFi connection has to be maintened in the classroom

Post-condition:

  • the teacher is able to create documents for his lesson and MCQ via the application
  • students are identified via their badges

Side-effects:

4. Product evolution

The SmartClassroom project is based on several scenarios realised by a number of groups. The part described here is just one of them. Future enhancements of this environment could be proposed and implemented by future groups in charge of developping this classroom.

5. Appendices

6. Index

Retrieved from "https://air.imag.fr/index.php?title=Proj-2014-2015-SmartClassroom/SRS&oldid=23048"