Difference between revisions of "RICM4 2017 2018 - OpenCity/ SRS"
(15 intermediate revisions by the same user not shown) | |||
Line 19: | Line 19: | ||
| 05/02/2018 |
| 05/02/2018 |
||
| Quentin F. |
| Quentin F. |
||
− | | Adding the template |
+ | | Adding the template + Writing part.1 to 3 |
| |
| |
||
| |
| |
||
|} |
|} |
||
+ | |||
+ | |||
+ | [https://trello.com/b/MkMCjVGg Click here] to follow our project via Trello. |
||
Line 28: | Line 31: | ||
==1.1 Purpose of the requirements document== |
==1.1 Purpose of the requirements document== |
||
* [https://getbootstrap.com/docs/4.0/getting-started/introduction/ Bootstrap documentation] |
* [https://getbootstrap.com/docs/4.0/getting-started/introduction/ Bootstrap documentation] |
||
− | * D3js documentation |
+ | * [https://d3js.org D3js documentation] |
==1.2 Scope of the product== |
==1.2 Scope of the product== |
||
Line 34: | Line 37: | ||
==1.3 Definitions, acronyms and abbreviations== |
==1.3 Definitions, acronyms and abbreviations== |
||
− | + | In French : |
|
− | '''AssMat''' : Assistante Maternelle |
+ | * '''AssMat''' : Assistante Maternelle |
− | '''EAJE''' : Equipement d'accueil du jeune enfant |
+ | * '''EAJE''' : Equipement d'accueil du jeune enfant |
− | '''PAJE''' : Prestation d'accueil du jeune enfant |
+ | * '''PAJE''' : Prestation d'accueil du jeune enfant |
− | '''AEEH''' : L'allocation d'éducation de l'enfant handicapé |
+ | * '''AEEH''' : L'allocation d'éducation de l'enfant handicapé |
− | '''AM''' : Allocation Mensuelle |
+ | * '''AM''' : Allocation Mensuelle |
− | '''SU''' : Secours d’Urgence |
+ | * '''SU''' : Secours d’Urgence |
− | '''École 1er Degré''' : Ecole primaire (école maternelle + école élémentaire) |
+ | * '''École 1er Degré''' : Ecole primaire (école maternelle + école élémentaire) |
==1.4 References== |
==1.4 References== |
||
Line 62: | Line 65: | ||
==2.3 User characteristics== |
==2.3 User characteristics== |
||
Two possibilities : |
Two possibilities : |
||
− | * If it is an individual, it can see all the data and navigate browse the website. |
+ | * If it is an '''individual''', it can see all the data and navigate browse the website. |
− | * If it is a department member, it can modify data through a special interface. |
+ | * If it is a '''department''' member, it can modify data through a special interface. |
+ | |||
==2.4 General constraints== |
==2.4 General constraints== |
||
The most important point is that everyone could easily and quickly understand the high quantity of data. A special attention is given to the narrative aspect to allow the client to be in immersion |
The most important point is that everyone could easily and quickly understand the high quantity of data. A special attention is given to the narrative aspect to allow the client to be in immersion |
||
Line 75: | Line 79: | ||
* emergent system properties and quality characteristics. |
* emergent system properties and quality characteristics. |
||
− | ==3.1 Requirement |
+ | ==3.1 Requirement Individual/Department member (in Structured Natural Language)== |
+ | '''Function''': Have access to the Isère's social data through a data visualisation website. |
||
⚫ | |||
+ | |||
+ | '''Description''': A responsive data visualisation website with a particular narrative aspect to immerse the user and made him forget the hard aspect of understanding the high quality of data. |
||
+ | |||
+ | '''Inputs''': Isère's social data in Excel array form. |
||
+ | |||
+ | '''Source''': Isère department. |
||
+ | |||
+ | '''Outputs''': A responsive website with narrative data visualisation and an interface to modify/update data. |
||
+ | |||
+ | '''Destination''': Individuals of the department or the rest of the world which want to know more about the department. |
||
+ | |||
+ | '''Action''': |
||
+ | * Natural language sentences (with MUST, MAY, SHALL) |
||
+ | The user may login as a individual or a department member, if it login as a simple user, it can see data and navigate freely browse the website, search data and more. Or if it is a department member, it can (with a password) modify and update the data through a simple interface, an array. |
||
+ | * 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''': Security |
||
+ | |||
+ | '''Pre-condition''': The users with a device with a browser and an internet connection. If the user want to modify the data, it need a password. |
||
+ | |||
+ | '''Post-condition''': All the users need to reload the page after a modification to see this last. |
||
+ | |||
+ | '''Side-effects''': NONE |
||
+ | |||
+ | ---- |
||
+ | |||
⚫ | |||
'''Description''': |
'''Description''': |
||
− | '''Inputs''': |
+ | '''Inputs''': |
− | '''Source''': |
+ | '''Source''': |
− | '''Outputs''': |
+ | '''Outputs''': |
− | '''Destination''': |
+ | '''Destination''': |
'''Action''': |
'''Action''': |
||
Line 94: | Line 127: | ||
* Tabular notations for several (condition --> action) tuples |
* Tabular notations for several (condition --> action) tuples |
||
− | '''Non functional requirements''': |
+ | '''Non functional requirements''': |
'''Pre-condition''': |
'''Pre-condition''': |
||
− | '''Post-condition''': |
+ | '''Post-condition''': |
'''Side-effects''': |
'''Side-effects''': |
Latest revision as of 13:59, 5 February 2018
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
Version | Date | Authors | Description | Validator | Validator Date | |
---|---|---|---|---|---|---|
0.1.0 | 05/02/2018 | Quentin F. | Adding the template + Writing part.1 to 3 |
Click here to follow our project via Trello.
1. Introduction
1.1 Purpose of the requirements document
1.2 Scope of the product
With this specific project, the interested area is limited to the department, here the Isère (38). But the entire world can have access to the data.
1.3 Definitions, acronyms and abbreviations
In French :
- AssMat : Assistante Maternelle
- EAJE : Equipement d'accueil du jeune enfant
- PAJE : Prestation d'accueil du jeune enfant
- AEEH : L'allocation d'éducation de l'enfant handicapé
- AM : Allocation Mensuelle
- SU : Secours d’Urgence
- École 1er Degré : Ecole primaire (école maternelle + école élémentaire)
1.4 References
Start from scratch.
1.5 Overview of the remainder of the document
None at the moment.
2. General description
2.1 Product perspective
The department will be able to modify and update the data, so all the data visualisation need to be dynamic.
2.2 Product functions
Our product is a responsive website of data visualisation of Isère’s social data. The client has a narrative experience in the website, it is a important point to permit to everyone to understand the high quantity of information.
2.3 User characteristics
Two possibilities :
- If it is an individual, it can see all the data and navigate browse the website.
- If it is a department member, it can modify data through a special interface.
2.4 General constraints
The most important point is that everyone could easily and quickly understand the high quantity of data. A special attention is given to the narrative aspect to allow the client to be in immersion
2.5 Assumptions and dependencies
- Isère’s social data
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 Individual/Department member (in Structured Natural Language)
Function: Have access to the Isère's social data through a data visualisation website.
Description: A responsive data visualisation website with a particular narrative aspect to immerse the user and made him forget the hard aspect of understanding the high quality of data.
Inputs: Isère's social data in Excel array form.
Source: Isère department.
Outputs: A responsive website with narrative data visualisation and an interface to modify/update data.
Destination: Individuals of the department or the rest of the world which want to know more about the department.
Action:
- Natural language sentences (with MUST, MAY, SHALL)
The user may login as a individual or a department member, if it login as a simple user, it can see data and navigate freely browse the website, search data and more. Or if it is a department member, it can (with a password) modify and update the data through a simple interface, an array.
- 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: Security
Pre-condition: The users with a device with a browser and an internet connection. If the user want to modify the data, it need a password.
Post-condition: All the users need to reload the page after a modification to see this last.
Side-effects: NONE
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
The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.