Difference between revisions of "RICM4 2017 2018 - Dashboard/ SRS"
| Line 73: | Line 73: | ||
==3.1 Requirement X.Y.Z (in Structured Natural Language)== |
==3.1 Requirement X.Y.Z (in Structured Natural Language)== |
||
| − | '''Function''': |
+ | '''Function''': User ressource allocation |
| − | '''Description''': |
+ | '''Description''': |
| − | '''Inputs''': |
+ | '''Inputs''': A token defining a user and a ressource list |
| − | '''Source''': |
+ | '''Source''': |
| + | '''Outputs''': A boolean to indicate that the ressource is allocated or not |
||
| − | '''Outputs''': |
||
'''Destination''': |
'''Destination''': |
||
'''Action''': |
'''Action''': |
||
| + | Select a user -> select ressources and dedicated values (<= available) -> validate -> notify user |
||
| − | * 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''': |
+ | '''Non functional requirements''': - |
| − | '''Pre-condition''': |
+ | '''Pre-condition''': A user token must be created |
| + | '''Post-condition''': The alllocated ressources must be locked to the user (should not apppear as available for the next allocations) |
||
| − | '''Post-condition''': |
||
| − | '''Side-effects''': |
+ | '''Side-effects''': - |
=4. Product evolution= |
=4. Product evolution= |
||
Revision as of 13:30, 5 February 2018
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
| Version | Date | Authors | Description | Validator | Validation Date | |
|---|---|---|---|---|---|---|
| 0.1.0 | TBC | TBC | TBC | TBC | TBC |
1. Introduction
1.1 Purpose of the requirements document
The SRS is a document describing the software system of our DashBoard project for OAR.
1.2 Scope of the product
Our web application is for people using AOR as manager of ressources tasks
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
A dashboard web application single page for the task manager and resource OAR.
2.2 Product functions
- Add/Remove ressources
- Submit/Delete/Configure jobs
- See information about ressources and tasks
- Restricted access : login/Logout
- Time management of the cluster (check saturated bus ...)
- Numerous graphic ways to monitor the grid
2.3 User characteristics
A user who will use the dashboard to manage ressources and tasks
2.4 General constraints
Make the interface as simple as possible for the user
Make It enough performant to be easily usable to the users
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: User ressource allocation
Description:
Inputs: A token defining a user and a ressource list
Source:
Outputs: A boolean to indicate that the ressource is allocated or not
Destination:
Action: Select a user -> select ressources and dedicated values (<= available) -> validate -> notify user
Non functional requirements: -
Pre-condition: A user token must be created
Post-condition: The alllocated ressources must be locked to the user (should not apppear as available for the next allocations)
Side-effects: -