Difference between revisions of "RICM4 2017 2018 - UltraTeam 7.1/ SRS"

From air
Jump to navigation Jump to search
(Created page with "<!DOCTYPE html> <html lang="en" dir="ltr" class="client-nojs"> <head> <title>SRS-Template - air</title> <meta charset="UTF-8" /> <meta name="generator" content="MediaWiki 1.19...")
 
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  +
The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.
−
<!DOCTYPE html>
  
−
<html lang="en" dir="ltr" class="client-nojs">
  
−
<head>
  
−
<title>SRS-Template - air</title>
  
−
<meta charset="UTF-8" />
  
−
<meta name="generator" content="MediaWiki 1.19.20+dfsg-2.3" />
  
−
<link rel="shortcut icon" href="/favicon.ico" />
  
−
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="air (en)" />
  
−
<link rel="EditURI" type="application/rsd+xml" href="https://air.imag.fr/api.php?action=rsd" />
  
−
<link rel="copyright" href="http://creativecommons.org/licenses/publicdomain/" />
  
−
<link rel="alternate" type="application/atom+xml" title="air Atom feed" href="/index.php?title=Special:RecentChanges&amp;feed=atom" />
  
−
<link rel="stylesheet" href="https://air.imag.fr/load.php?debug=false&amp;lang=en&amp;modules=mediawiki.legacy.commonPrint%2Cshared%7Cskins.vector&amp;only=styles&amp;skin=vector&amp;*" />
  
−
<meta name="ResourceLoaderDynamicStyles" content="" />
  
−
<link rel="stylesheet" href="https://air.imag.fr/load.php?debug=false&amp;lang=en&amp;modules=site&amp;only=styles&amp;skin=vector&amp;*" />
  
−
<style>a:lang(ar),a:lang(ckb),a:lang(fa),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none}a.new,#quickbar a.new{color:#ba0000}
  
   
−
/* cache key: air-air:resourceloader:filter:minify-css:7:c88e2bcd56513749bec09a7e29cb3ffa */
  
−
</style>
  
   
  +
'''Read first:'''
−
<script src="https://air.imag.fr/load.php?debug=false&amp;lang=en&amp;modules=startup&amp;only=scripts&amp;skin=vector&amp;*"></script>
  
  +
* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
−
<script>if(window.mw){
  
  +
* http://en.wikipedia.org/wiki/Software_requirements_specification
−
mw.config.set({"wgCanonicalNamespace":"","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":0,"wgPageName":"SRS-Template","wgTitle":"SRS-Template","wgCurRevisionId":25949,"wgArticleId":1306,"wgIsArticle":true,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgBreakFrames":false,"wgPageContentLanguage":"en","wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgRelevantPageName":"SRS-Template","wgRestrictionEdit":[],"wgRestrictionMove":[]});
  
  +
* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]
−
}</script><script>if(window.mw){
  
−
mw.loader.implement("user.options",function($){mw.user.options.set({"ccmeonemails":0,"cols":80,"date":"default","diffonly":0,"disablemail":0,"disablesuggest":0,"editfont":"default","editondblclick":0,"editsection":1,"editsectiononrightclick":0,"enotifminoredits":0,"enotifrevealaddr":0,"enotifusertalkpages":1,"enotifwatchlistpages":0,"extendwatchlist":0,"externaldiff":0,"externaleditor":0,"fancysig":0,"forceeditsummary":0,"gender":"unknown","hideminor":0,"hidepatrolled":0,"highlightbroken":1,"imagesize":2,"justify":0,"math":1,"minordefault":0,"newpageshidepatrolled":0,"nocache":0,"noconvertlink":0,"norollbackdiff":0,"numberheadings":0,"previewonfirst":0,"previewontop":1,"quickbar":5,"rcdays":7,"rclimit":50,"rememberpassword":0,"rows":25,"searchlimit":20,"showhiddencats":0,"showjumplinks":1,"shownumberswatching":1,"showtoc":1,"showtoolbar":1,"skin":"vector","stubthreshold":0,"thumbsize":2,"underline":2,"uselivepreview":0,"usenewrc":0,"watchcreations":0,"watchdefault":0,"watchdeletion":0,
  
−
"watchlistdays":3,"watchlisthideanons":0,"watchlisthidebots":0,"watchlisthideliu":0,"watchlisthideminor":0,"watchlisthideown":0,"watchlisthidepatrolled":0,"watchmoves":0,"wllimit":250,"variant":"en","language":"en","searchNs0":true,"searchNs1":false,"searchNs2":false,"searchNs3":false,"searchNs4":false,"searchNs5":false,"searchNs6":false,"searchNs7":false,"searchNs8":false,"searchNs9":false,"searchNs10":false,"searchNs11":false,"searchNs12":false,"searchNs13":false,"searchNs14":false,"searchNs15":false});;},{},{});mw.loader.implement("user.tokens",function($){mw.user.tokens.set({"editToken":"+\\","watchToken":false});;},{},{});
  
   
  +
{|class="wikitable alternance"
−
/* cache key: air-air:resourceloader:filter:minify-js:7:9983699ab6150ffa89a90653b2338ac8 */
  
  +
|+ Document History
−
}</script>
  
  +
|-
−
<script>if(window.mw){
  
  +
|
−
mw.loader.load(["mediawiki.page.startup","mediawiki.legacy.wikibits","mediawiki.legacy.ajax"]);
  
  +
!scope="col"| Version
−
}</script>
  
  +
!scope="col"| Date
−
<!--[if lt IE 7]><style type="text/css">body{behavior:url("/skins/vector/csshover.min.htc")}</style><![endif]--></head>
  
  +
!scope="col"| Authors
−
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-SRS-Template skin-vector action-view">
  
  +
!scope="col"| Description
−
<div id="mw-page-base" class="noprint"></div>
  
  +
!scope="col"| Validator
−
<div id="mw-head-base" class="noprint"></div>
  
  +
!scope="col"| Validation Date
−
<!-- content -->
  
  +
|-
−
<div id="content" class="mw-body">
  
  +
!scope="row" |
−
<a id="top"></a>
  
  +
| 0.1.0
−
<div id="mw-js-message" style="display:none;"></div>
  
  +
| TBC
−
<!-- firstHeading -->
  
  +
| TBC
−
<h1 id="firstHeading" class="firstHeading">
  
  +
| TBC
−
<span dir="auto">SRS-Template</span>
  
  +
| TBC
−
</h1>
  
  +
| TBC
−
<!-- /firstHeading -->
  
−
<!-- bodyContent -->
  
−
<div id="bodyContent">
  
−
<!-- tagline -->
  
−
<div id="siteSub">From air</div>
  
−
<!-- /tagline -->
  
−
<!-- subtitle -->
  
−
<div id="contentSub"></div>
  
−
<!-- /subtitle -->
  
−
<!-- jumpto -->
  
−
<div id="jump-to-nav" class="mw-jump">
  
−
Jump to: <a href="#mw-head">navigation</a>,
  
−
<a href="#p-search">search</a>
  
−
</div>
  
−
<!-- /jumpto -->
  
−
<!-- bodycontent -->
  
−
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><p>The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.
  
−
</p><p><br />
  
−
<b>Read first:</b>
  
−
</p>
  
−
<ul><li> <a rel="nofollow" class="external free" href="http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx">http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx</a>
  
−
</li><li> <a rel="nofollow" class="external free" href="http://en.wikipedia.org/wiki/Software_requirements_specification">http://en.wikipedia.org/wiki/Software_requirements_specification</a>
  
−
</li><li> <a rel="nofollow" class="external text" href="http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf">IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998</a>
  
−
</li></ul>
  
−
<table class="wikitable alternance">
  
−
<caption> Document History
  
−
</caption>
  
−
<tr>
  
−
<td>
  
−
</td>
  
−
<th scope="col"> Version
  
−
</th>
  
−
<th scope="col"> Date
  
−
</th>
  
−
<th scope="col"> Authors
  
−
</th>
  
−
<th scope="col"> Description
  
−
</th>
  
−
<th scope="col"> Validator
  
−
</th>
  
−
<th scope="col"> Validation Date
  
−
</th></tr>
  
−
<tr>
  
−
<th scope="row">
  
−
</th>
  
−
<td> 0.1.0
  
−
</td>
  
−
<td> TBC
  
−
</td>
  
−
<td> TBC
  
−
</td>
  
−
<td> TBC
  
−
</td>
  
−
<td> TBC
  
−
</td>
  
−
<td> TBC
  
−
</td></tr></table>
  
−
<p><br />
  
−
</p>
  
−
<table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Contents</h2></div>
  
−
<ul>
  
−
<li class="toclevel-1 tocsection-1"><a href="#1._Introduction"><span class="tocnumber">1</span> <span class="toctext">1. Introduction</span></a>
  
−
<ul>
  
−
<li class="toclevel-2 tocsection-2"><a href="#1.1_Purpose_of_the_requirements_document"><span class="tocnumber">1.1</span> <span class="toctext">1.1 Purpose of the requirements document</span></a></li>
  
−
<li class="toclevel-2 tocsection-3"><a href="#1.2_Scope_of_the_product"><span class="tocnumber">1.2</span> <span class="toctext">1.2 Scope of the product</span></a></li>
  
−
<li class="toclevel-2 tocsection-4"><a href="#1.3_Definitions.2C_acronyms_and_abbreviations"><span class="tocnumber">1.3</span> <span class="toctext">1.3 Definitions, acronyms and abbreviations</span></a></li>
  
−
<li class="toclevel-2 tocsection-5"><a href="#1.4_References"><span class="tocnumber">1.4</span> <span class="toctext">1.4 References</span></a></li>
  
−
<li class="toclevel-2 tocsection-6"><a href="#1.5_Overview_of_the_remainder_of_the_document"><span class="tocnumber">1.5</span> <span class="toctext">1.5 Overview of the remainder of the document</span></a></li>
  
−
</ul>
  
−
</li>
  
−
<li class="toclevel-1 tocsection-7"><a href="#2._General_description"><span class="tocnumber">2</span> <span class="toctext">2. General description</span></a>
  
−
<ul>
  
−
<li class="toclevel-2 tocsection-8"><a href="#2.1_Product_perspective"><span class="tocnumber">2.1</span> <span class="toctext">2.1 Product perspective</span></a></li>
  
−
<li class="toclevel-2 tocsection-9"><a href="#2.2_Product_functions"><span class="tocnumber">2.2</span> <span class="toctext">2.2 Product functions</span></a></li>
  
−
<li class="toclevel-2 tocsection-10"><a href="#2.3_User_characteristics"><span class="tocnumber">2.3</span> <span class="toctext">2.3 User characteristics</span></a></li>
  
−
<li class="toclevel-2 tocsection-11"><a href="#2.4_General_constraints"><span class="tocnumber">2.4</span> <span class="toctext">2.4 General constraints</span></a></li>
  
−
<li class="toclevel-2 tocsection-12"><a href="#2.5_Assumptions_and_dependencies"><span class="tocnumber">2.5</span> <span class="toctext">2.5 Assumptions and dependencies</span></a></li>
  
−
</ul>
  
−
</li>
  
−
<li class="toclevel-1 tocsection-13"><a href="#3.Specific_requirements.2C_covering_functional.2C_non-functional_and_interface_requirements"><span class="tocnumber">3</span> <span class="toctext">3.Specific requirements, covering functional, non-functional and interface requirements</span></a>
  
−
<ul>
  
−
<li class="toclevel-2 tocsection-14"><a href="#3.1_Requirement_X.Y.Z_.28in_Structured_Natural_Language.29"><span class="tocnumber">3.1</span> <span class="toctext">3.1 Requirement X.Y.Z (in Structured Natural Language)</span></a></li>
  
−
</ul>
  
−
</li>
  
−
<li class="toclevel-1 tocsection-15"><a href="#4._Product_evolution"><span class="tocnumber">4</span> <span class="toctext">4. Product evolution</span></a></li>
  
−
<li class="toclevel-1 tocsection-16"><a href="#5._Appendices"><span class="tocnumber">5</span> <span class="toctext">5. Appendices</span></a></li>
  
−
<li class="toclevel-1 tocsection-17"><a href="#6._Index"><span class="tocnumber">6</span> <span class="toctext">6. Index</span></a></li>
  
−
</ul>
  
−
</td></tr></table>
  
−
<h1> <span class="mw-headline" id="1._Introduction">1. Introduction</span></h1>
  
−
<h2> <span class="mw-headline" id="1.1_Purpose_of_the_requirements_document">1.1 Purpose of the requirements document</span></h2>
  
−
<h2> <span class="mw-headline" id="1.2_Scope_of_the_product">1.2 Scope of the product</span></h2>
  
−
<h2> <span class="mw-headline" id="1.3_Definitions.2C_acronyms_and_abbreviations">1.3 Definitions, acronyms and abbreviations</span></h2>
  
−
<h2> <span class="mw-headline" id="1.4_References">1.4 References</span></h2>
  
−
<h2> <span class="mw-headline" id="1.5_Overview_of_the_remainder_of_the_document">1.5 Overview of the remainder of the document</span></h2>
  
−
<h1> <span class="mw-headline" id="2._General_description">2. General description</span></h1>
  
−
<h2> <span class="mw-headline" id="2.1_Product_perspective">2.1 Product perspective</span></h2>
  
−
<h2> <span class="mw-headline" id="2.2_Product_functions">2.2 Product functions</span></h2>
  
−
<h2> <span class="mw-headline" id="2.3_User_characteristics">2.3 User characteristics</span></h2>
  
−
<h2> <span class="mw-headline" id="2.4_General_constraints">2.4 General constraints</span></h2>
  
−
<h2> <span class="mw-headline" id="2.5_Assumptions_and_dependencies">2.5 Assumptions and dependencies</span></h2>
  
−
<h1> <span class="mw-headline" id="3.Specific_requirements.2C_covering_functional.2C_non-functional_and_interface_requirements">3.Specific requirements, covering functional, non-functional and interface requirements</span></h1>
  
−
<ul><li> document external interfaces,
  
−
</li><li> describe system functionality and performance
  
−
</li><li> specify logical database requirements,
  
−
</li><li> design constraints,
  
−
</li><li> emergent system properties and quality characteristics.
  
−
</li></ul>
  
−
<h2> <span class="mw-headline" id="3.1_Requirement_X.Y.Z_.28in_Structured_Natural_Language.29">3.1 Requirement X.Y.Z (in Structured Natural Language)</span></h2>
  
−
<p><b>Function</b>:
  
−
</p><p><b>Description</b>:
  
−
</p><p><b>Inputs</b>:
  
−
</p><p><b>Source</b>:
  
−
</p><p><b>Outputs</b>:
  
−
</p><p><b>Destination</b>:
  
−
</p><p><b>Action</b>:
  
−
</p>
  
−
<ul><li> Natural language sentences (with MUST, MAY, SHALL)
  
−
</li><li> Graphical Notations&#160;: UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
  
−
</li><li> Mathematical Notations
  
−
</li><li> Tabular notations for several (condition --&gt; action) tuples
  
−
</li></ul>
  
−
<p><b>Non functional requirements</b>:
  
−
</p><p><b>Pre-condition</b>:
  
−
</p><p><b>Post-condition</b>:
  
−
</p><p><b>Side-effects</b>:
  
−
</p>
  
−
<h1> <span class="mw-headline" id="4._Product_evolution">4. Product evolution</span></h1>
  
−
<h1> <span class="mw-headline" id="5._Appendices">5. Appendices</span></h1>
  
−
<h1> <span class="mw-headline" id="6._Index">6. Index</span></h1>
  
   
  +
|}
−
<!--
  
−
NewPP limit report
  
−
Preprocessor node count: 67/1000000
  
−
Post‐expand include size: 0/2097152 bytes
  
−
Template argument size: 0/2097152 bytes
  
−
Expensive parser function count: 0/100
  
−
-->
  
   
−
<!-- Saved in parser cache with key air-air:pcache:idhash:1306-0!*!*!!en!*!* and timestamp 20180205070347 -->
  
−
</div> <!-- /bodycontent -->
  
−
<!-- printfooter -->
  
−
<div class="printfooter">
  
−
Retrieved from "<a href="https://air.imag.fr/index.php?title=SRS-Template&amp;oldid=25949">https://air.imag.fr/index.php?title=SRS-Template&amp;oldid=25949</a>" </div>
  
−
<!-- /printfooter -->
  
−
<!-- catlinks -->
  
−
<div id='catlinks' class='catlinks catlinks-allhidden'></div> <!-- /catlinks -->
  
−
<div class="visualClear"></div>
  
−
<!-- debughtml -->
  
−
<!-- /debughtml -->
  
−
</div>
  
−
<!-- /bodyContent -->
  
−
</div>
  
−
<!-- /content -->
  
−
<!-- header -->
  
−
<div id="mw-head" class="noprint">
  
   
  +
=1. Introduction=
−
<!-- 0 -->
  
  +
==1.1 Purpose of the requirements document==
−
<div id="p-personal" class="">
  
  +
This Software Requirements Specification (SRS) identifies the requirements for project [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1 UltraTeam 7.1]
−
<h5>Personal tools</h5>
  
  +
This document is a guideline about the functionalities offered and the problems that the system solves.
−
<ul>
  
−
<li id="pt-login"><a href="/index.php?title=Special:UserLogin&amp;returnto=SRS-Template" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o">Log in</a></li>
  
−
</ul>
  
−
</div>
  
   
  +
==1.2 Scope of the product==
−
<!-- /0 -->
  
  +
The aim of this project is to create a Web Site with these specifications :
−
<div id="left-navigation">
  
  +
* Collect data from the web application [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV]
  +
* Synchronize data between server and clients
  +
* Data visualization (from [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] hikes)
   
  +
This project may allow hikers to visualize their hikes.
−
<!-- 0 -->
  
−
<div id="p-namespaces" class="vectorTabs">
  
−
<h5>Namespaces</h5>
  
−
<ul>
  
−
<li id="ca-nstab-main" class="selected"><span><a href="/index.php/SRS-Template" title="View the content page [c]" accesskey="c">Page</a></span></li>
  
−
<li id="ca-talk" class="new"><span><a href="/index.php?title=Talk:SRS-Template&amp;action=edit&amp;redlink=1" title="Discussion about the content page [t]" accesskey="t">Discussion</a></span></li>
  
−
</ul>
  
−
</div>
  
   
  +
It will also permit the synchronization of positions during the hike.
−
<!-- /0 -->
  
   
  +
==1.3 Definitions, acronyms and abbreviations==
−
<!-- 1 -->
  
  +
DB = Data Base
−
<div id="p-variants" class="vectorMenu emptyPortlet">
  
−
<h4>
  
−
</h4>
  
−
<h5><span>Variants</span><a href="#"></a></h5>
  
−
<div class="menu">
  
−
<ul>
  
−
</ul>
  
−
</div>
  
−
</div>
  
   
  +
GPS = Global Positionning System
−
<!-- /1 -->
  
−
</div>
  
−
<div id="right-navigation">
  
   
  +
==1.4 References==
−
<!-- 0 -->
  
  +
*The main page of the project: [http://air.imag.fr/index.php/UltraTeam UltraTeam]
−
<div id="p-views" class="vectorTabs">
  
  +
*The page of our contribution [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1 UltraTeam_7.1]
−
<h5>Views</h5>
  
  +
*[https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeam_7.1/UML UML] diagrams
−
<ul>
  
−
<li id="ca-view" class="selected"><span><a href="/index.php/SRS-Template" >Read</a></span></li>
  
−
<li id="ca-viewsource"><span><a href="/index.php?title=SRS-Template&amp;action=edit" title="This page is protected.&#10;You can view its source [e]" accesskey="e">View source</a></span></li>
  
−
<li id="ca-history" class="collapsible"><span><a href="/index.php?title=SRS-Template&amp;action=history" title="Past revisions of this page [h]" accesskey="h">View history</a></span></li>
  
−
</ul>
  
−
</div>
  
   
  +
==1.5 Overview of the remainder of the document==
−
<!-- /0 -->
  
   
  +
=2. General description=
−
<!-- 1 -->
  
  +
==2.1 Product perspective==
−
<div id="p-cactions" class="vectorMenu emptyPortlet">
  
  +
Our Web site is an open source project.
−
<h5><span>Actions</span><a href="#"></a></h5>
  
−
<div class="menu">
  
−
<ul>
  
−
</ul>
  
−
</div>
  
−
</div>
  
   
  +
This site will store and display data (GPS localisation from [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] users ).
−
<!-- /1 -->
  
   
  +
==2.2 Product functions==
−
<!-- 2 -->
  
  +
*Centralization and synchronization of data.
−
<div id="p-search">
  
  +
*Data visualization.
−
<h5><label for="searchInput">Search</label></h5>
  
−
<form action="/index.php" id="searchform">
  
−
<div>
  
−
<input type="search" name="search" title="Search air [f]" accesskey="f" id="searchInput" /> <input type="submit" name="go" value="Go" title="Go to a page with this exact name if exists" id="searchGoButton" class="searchButton" /> <input type="submit" name="fulltext" value="Search" title="Search the pages for this text" id="mw-searchButton" class="searchButton" /> <input type='hidden' name="title" value="Special:Search"/>
  
−
</div>
  
−
</form>
  
−
</div>
  
   
  +
==2.3 User characteristics==
−
<!-- /2 -->
  
  +
The typical user is a hiker who did a hike using [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] application.
−
</div>
  
  +
The user doesn't need specific or technical knowledge, just a basic Internet usage.
−
</div>
  
−
<!-- /header -->
  
−
<!-- panel -->
  
−
<div id="mw-panel" class="noprint">
  
−
<!-- logo -->
  
−
<div id="p-logo"><a style="background-image: url(/images/logo_air.png);" href="/index.php/Main_Page" title="Visit the main page"></a></div>
  
−
<!-- /logo -->
  
   
  +
==2.4 General constraints==
−
<!-- navigation -->
  
  +
To visualize the hike, the user will have to use an external application developed by our colleagues.
−
<div class="portal" id='p-navigation'>
  
  +
An Internet connection will be necessary to upload data from the application to the server.
−
<h5>Navigation</h5>
  
  +
(Not necessarily at any time of the hike)
−
<div class="body">
  
−
<ul>
  
−
<li id="n-mainpage-description"><a href="/index.php/Main_Page" title="Visit the main page [z]" accesskey="z">Main page</a></li>
  
−
<li id="n-Projets-2017-2018"><a href="/index.php/Projets_2017-2018">Projets 2017-2018</a></li>
  
−
<li id="n-Projets"><a href="/index.php/Projets">Projets</a></li>
  
−
<li id="n-S.C3.A9minaires-Th.C3.A9ma.-2016-2017"><a href="/index.php/S%C3%A9minaires_Th%C3%A9matiques_2016-2017">Séminaires Théma. 2016-2017</a></li>
  
−
<li id="n-Mat.C3.A9riels"><a href="/index.php/Liste_des_%C3%A9quipements_disponibles">Matériels</a></li>
  
−
<li id="n-Logiciels"><a href="/index.php/Logiciels">Logiciels</a></li>
  
−
<li id="n-Historique-des-Projets"><a href="/index.php/Projets">Historique des Projets</a></li>
  
−
<li id="n-FAQ"><a href="/index.php/FAQ">FAQ</a></li>
  
−
<li id="n-recentchanges"><a href="/index.php/Special:RecentChanges" title="A list of recent changes in the wiki [r]" accesskey="r">Recent changes</a></li>
  
−
<li id="n-randompage"><a href="/index.php/Special:Random" title="Load a random page [x]" accesskey="x">Random page</a></li>
  
−
<li id="n-Twitter"><a href="https://twitter.com/FablabAIR" rel="nofollow">Twitter</a></li>
  
−
<li id="n-Others-Languages"><a href="http://service.aximag.fr//xwiki/bin/view/imag/airimagfr" rel="nofollow">Others Languages</a></li>
  
−
<li id="n-help"><a href="/index.php/Help:Contents" title="The place to find out">Help</a></li>
  
−
</ul>
  
−
</div>
  
−
</div>
  
   
  +
==2.5 Assumptions and dependencies==
−
<!-- /navigation -->
  
  +
This project fully depends on [https://air.imag.fr/index.php/RICM4_2017_2018_-_UltraTeamMV UltraTeamMV] project to collect data.
   
  +
=3.Specific requirements, covering functional, non-functional and interface requirements=
−
<!-- multilingual version -->
  
  +
* document external interfaces,
−
<div class="portal" id='p-multilingual_version'>
  
  +
* describe system functionality and performance
−
<h5>multilingual version</h5>
  
  +
* specify logical database requirements,
−
<div class="body">
  
  +
* design constraints,
−
<ul>
  
  +
* emergent system properties and quality characteristics.
−
<li id="n-by-AxiMAG"><a href="http://service.aximag.fr//xwiki/bin/view/imag/airimagfr" rel="nofollow">by AxiMAG</a></li>
  
−
</ul>
  
−
</div>
  
−
</div>
  
   
−
<!-- /multilingual version -->
  
   
  +
==3.1 Requirement 1 : Load and store DATA==
−
<!-- SEARCH -->
  
   
  +
'''Function''': Take data (user localization and distress state) via HTTP (REST API).
−
<!-- /SEARCH -->
  
   
  +
'''Description''': We will collect information from users (Smart-phone application -> Server) through REST API.
−
<!-- TOOLBOX -->
  
−
<div class="portal" id='p-tb'>
  
−
<h5>Tools</h5>
  
−
<div class="body">
  
−
<ul>
  
−
<li id="t-whatlinkshere"><a href="/index.php/Special:WhatLinksHere/SRS-Template" title="A list of all wiki pages that link here [j]" accesskey="j">What links here</a></li>
  
−
<li id="t-recentchangeslinked"><a href="/index.php/Special:RecentChangesLinked/SRS-Template" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li>
  
−
<li id="t-specialpages"><a href="/index.php/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li>
  
−
<li><a href="/index.php?title=SRS-Template&amp;printable=yes" rel="alternate">Printable version</a></li>
  
−
<li id="t-permalink"><a href="/index.php?title=SRS-Template&amp;oldid=25949" title="Permanent link to this revision of the page">Permanent link</a></li>
  
−
</ul>
  
−
</div>
  
−
</div>
  
   
  +
'''Inputs''': Information about the user (localization, distress state, ID, post date)
−
<!-- /TOOLBOX -->
  
   
  +
'''Source''': User application (Smart-phone)
−
<!-- LANGUAGES -->
  
   
  +
'''Outputs''': Data stored in the server DB
−
<!-- /LANGUAGES -->
  
  +
−
</div>
  
  +
'''Destination''': Server
−
<!-- /panel -->
  
  +
−
<!-- footer -->
  
  +
'''Action''':
−
<div id="footer">
  
  +
* Smart-phone post request (input)
−
<ul id="footer-info">
  
  +
* REST API - update the DB
−
<li id="footer-info-lastmod"> This page was last modified on 19 January 2016, at 17:42.</li>
  
  +
−
<li id="footer-info-viewcount">This page has been accessed 1,420 times.</li>
  
  +
'''Non functional requirements''': None.
−
<li id="footer-info-copyright">Content is available under <a class="external" href="http://creativecommons.org/licenses/publicdomain/">Public Domain</a> unless otherwise noted.</li>
  
  +
−
</ul>
  
  +
'''Pre-condition''': Smartphone Application, Internet connection.
−
<ul id="footer-places">
  
  +
−
<li id="footer-places-privacy"><a href="/index.php/air:Privacy_policy" title="air:Privacy policy">Privacy policy</a></li>
  
  +
'''Post-condition''': None.
−
<li id="footer-places-about"><a href="/index.php/air:About" title="air:About">About air</a></li>
  
  +
−
<li id="footer-places-disclaimer"><a href="/index.php/air:General_disclaimer" title="air:General disclaimer">Disclaimers</a></li>
  
  +
'''Side-effects''': None.
−
</ul>
  
  +
−
<ul id="footer-icons" class="noprint">
  
  +
−
<li id="footer-copyrightico">
  
  +
==3.2 Requirement 2 : Send DATA==
−
<a href="http://creativecommons.org/licenses/publicdomain/"><img src="/skins/common/images/public-domain.png" alt="Public Domain" width="88" height="31" /></a>
  
  +
−
</li>
  
  +
'''Function''': Send data (user localization and distress state) via HTTP (REST API) to every hikers of the hike.
−
<li id="footer-poweredbyico">
  
  +
−
<a href="//www.mediawiki.org/"><img src="/skins/common/images/poweredby_mediawiki_88x31.png" alt="Powered by MediaWiki" width="88" height="31" /></a>
  
  +
'''Description''': We will send information (if necessary) to any hikers (who are in the same hike) (Server -> Smart-phone application ) through REST API.
−
</li>
  
  +
−
</ul>
  
  +
'''Inputs''': Request of information
−
<div style="clear:both"></div>
  
  +
−
</div>
  
  +
'''Source''': User application (Smart-phone)
−
<!-- /footer -->
  
  +
−
<script src="https://air.imag.fr/load.php?debug=false&amp;lang=en&amp;modules=skins.vector&amp;only=scripts&amp;skin=vector&amp;*"></script>
  
  +
'''Outputs''': Information about users (localization, distress state, ID, post date)
−
<script>if(window.mw){
  
  +
−
mw.loader.load(["mediawiki.user","mediawiki.page.ready"], null, true);
  
  +
'''Destination''': User application (Smart-phone)
−
}</script>
  
  +
−
<script src="https://air.imag.fr/load.php?debug=false&amp;lang=en&amp;modules=site&amp;only=scripts&amp;skin=vector&amp;*"></script>
  
  +
'''Action''':
−
<!-- Served in 0.070 secs. -->
  
  +
* Smart-phone get request (input)
−
</body>
  
  +
* REST API
−
</html>
  
  +
  +
'''Non functional requirements''': None.
  +
  +
'''Pre-condition''': Smartphone Application, Internet connection.
  +
  +
'''Post-condition''': None.
  +
  +
'''Side-effects''': None.
  +
  +
  +
  +
==3.3 Requirement 3 : Display Hikes==
  +
  +
'''Function''': Display details of a hike (user localization and hike information).
  +
  +
'''Description''': We will display information of a specific hike and we will also display a map of the itinerary (with real time positions).
  +
  +
'''Inputs''': User hike and localizations
  +
  +
'''Source''': User (web-site)
  +
  +
'''Outputs''': Information about a specific hike (localization, distress state)
  +
  +
'''Destination''': User (web-site)
  +
  +
'''Action''':
  +
* Connect to an user profile
  +
* Go on hike page
  +
* Select a specific hike
  +
  +
'''Non functional requirements''': None.
  +
  +
'''Pre-condition''': Internet connection, user account
  +
  +
'''Post-condition''': None.
  +
  +
'''Side-effects''': None.
  +
  +
=4. Product evolution=
  +
  +
What must be done to make this project evolve is to make the link between the mobile application and the web application.
  +
  +
The databases and data models between the two applications are already consistent.
  +
It will be necessary to be able to send messages (entity) from the mobile application to the web application with the REST API.
  +
  +
The SOS principle is also already implemented on the web application, all that remains is to make visible all the hikes with at least one SOS for users of the "Emergency" type (not currently implemented).
  +
  +
=5. Appendices=
  +
  +
==5.1. SRS structure==
  +
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.
  +
  +
'''References:'''
  +
* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
  +
* http://en.wikipedia.org/wiki/Software_requirements_specification
  +
* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]
  +
  +
=6. Index=

Latest revision as of 10:52, 3 April 2018

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 TBC TBC TBC TBC TBC


1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for project UltraTeam 7.1 This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product

The aim of this project is to create a Web Site with these specifications :

  • Collect data from the web application UltraTeamMV
  • Synchronize data between server and clients
  • Data visualization (from UltraTeamMV hikes)

This project may allow hikers to visualize their hikes.

It will also permit the synchronization of positions during the hike.

1.3 Definitions, acronyms and abbreviations

DB = Data Base

GPS = Global Positionning System

1.4 References

1.5 Overview of the remainder of the document

2. General description

2.1 Product perspective

Our Web site is an open source project.

This site will store and display data (GPS localisation from UltraTeamMV users ).

2.2 Product functions

  • Centralization and synchronization of data.
  • Data visualization.

2.3 User characteristics

The typical user is a hiker who did a hike using UltraTeamMV application. The user doesn't need specific or technical knowledge, just a basic Internet usage.

2.4 General constraints

To visualize the hike, the user will have to use an external application developed by our colleagues. An Internet connection will be necessary to upload data from the application to the server. (Not necessarily at any time of the hike)

2.5 Assumptions and dependencies

This project fully depends on UltraTeamMV project to collect 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 1 : Load and store DATA

Function: Take data (user localization and distress state) via HTTP (REST API).

Description: We will collect information from users (Smart-phone application -> Server) through REST API.

Inputs: Information about the user (localization, distress state, ID, post date)

Source: User application (Smart-phone)

Outputs: Data stored in the server DB

Destination: Server

Action:

  • Smart-phone post request (input)
  • REST API - update the DB

Non functional requirements: None.

Pre-condition: Smartphone Application, Internet connection.

Post-condition: None.

Side-effects: None.


3.2 Requirement 2 : Send DATA

Function: Send data (user localization and distress state) via HTTP (REST API) to every hikers of the hike.

Description: We will send information (if necessary) to any hikers (who are in the same hike) (Server -> Smart-phone application ) through REST API.

Inputs: Request of information

Source: User application (Smart-phone)

Outputs: Information about users (localization, distress state, ID, post date)

Destination: User application (Smart-phone)

Action:

  • Smart-phone get request (input)
  • REST API

Non functional requirements: None.

Pre-condition: Smartphone Application, Internet connection.

Post-condition: None.

Side-effects: None.


3.3 Requirement 3 : Display Hikes

Function: Display details of a hike (user localization and hike information).

Description: We will display information of a specific hike and we will also display a map of the itinerary (with real time positions).

Inputs: User hike and localizations

Source: User (web-site)

Outputs: Information about a specific hike (localization, distress state)

Destination: User (web-site)

Action:

  • Connect to an user profile
  • Go on hike page
  • Select a specific hike

Non functional requirements: None.

Pre-condition: Internet connection, user account

Post-condition: None.

Side-effects: None.

4. Product evolution

What must be done to make this project evolve is to make the link between the mobile application and the web application.

The databases and data models between the two applications are already consistent. It will be necessary to be able to send messages (entity) from the mobile application to the web application with the REST API.

The SOS principle is also already implemented on the web application, all that remains is to make visible all the hikes with at least one SOS for users of the "Emergency" type (not currently implemented).

5. Appendices

5.1. SRS structure

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

References:

6. Index

Retrieved from "https://air.imag.fr/index.php?title=RICM4_2017_2018_-_UltraTeam_7.1/_SRS&oldid=41209"