From 07e16d44775b6954a1ccf8d7321d44a13b41b81a Mon Sep 17 00:00:00 2001 From: henningxtro Date: Wed, 9 Dec 2020 19:12:03 +0100 Subject: [PATCH] Updated SRS (markdown) --- SRS.md | 44 +++++++++++++++----------------------------- 1 file changed, 15 insertions(+), 29 deletions(-) diff --git a/SRS.md b/SRS.md index 18ae964..6c1bab1 100644 --- a/SRS.md +++ b/SRS.md @@ -21,31 +21,23 @@ - [2.2 Product perspective](#22-product-perspective) - [2.3 User characteristics](#23-user-characteristics) - - [2.4 Dependencies](#24-dependencies) - [3. Specific Requirements](#3-specific-requirements) - - [3.1 Functionality – Data Backend](#31-functionality--data-backend) + - [3.1 Functionality](#31-functionality--data-backend) + - [3.1.1 Functionality - Backend](#312) + - [3.1.2 Functionality - Database](#313) + - [3.1.3 Functionality - Webcrawler](#313) - - [3.1.1 Read data given over API endpoints](#311-read-data-given-over-api-endpoints) - - [3.1.2 Parse data](#312-parse-data) - - [3.1.3 Provide data](#313-provide-data) - - - [3.2 Functionality – User Interface](#32-functionality--user-interface) + - [3.2 Functionality – Functionality - Frontend](#32-functionality--user-interface) - [3.2.1 User system](#321-user-system) - - [3.2.3 Flashcard boxes](#323-flashcard-boxes) - - [3.2.4 Flashcards](#324-flashcards) - - [3.2.5 Statistics](#325-statistics) - [3.3 Usability](#33-usability) - [3.4 Reliability](#34-reliability) - [3.4.1 Availability](#341-availability) - - [3.4.2 MTBF, MTTR](#342-mtbf-mttr) - - [3.4.3 Accuracy](#343-accuracy) - - [3.4.4 Bug classes](#344-bug-classes) - [3.5 Performance](#35-performance) @@ -57,11 +49,8 @@ - [3.6 Supportability](#36-supportability) - [3.7 Design Constraints](#37-design-constraints) - - - [3.7.1 Development tools](#371-development-tools) - - [3.7.2 Spring Boot](#372-spring-boot) - - [3.7.3 ReactJS](#373-reactjs) - - [3.7.4 Supported Platforms](#374-supported-platforms) + - [3.7.1 Development tools](#37-design-constraints) + - [3.7.2 Support Platform](#37-design-constraints) - [3.8 Online User Documentation and Help System Requirements](#38-online-user-documentation-and-help-system-requirements) @@ -75,11 +64,9 @@ - [3.10.4 Communications Interfaces](#3104-communications-interfaces) - [3.11 Licensing Requirements](#311-licensing-requirements) - + - [3.12 Legal, Copyright and other Notices](#312-legal-copyright-and-other-notices) - - [3.13 Applicable Standards](#313-applicable-standards) - - [4. Supporting Information](#4-supporting-information) ## 1. Introduction @@ -132,20 +119,19 @@ So we need to make sure, that we have a very good useability. ### 3.1 Functionality -#### 3.1.1 Functionality - Frontend -The User interface should be intuitive and appealing. It should be lightweight and not overloaded with features so anyone is easily able to use our service. - -#### 3.1.2 Functionality – Backend +#### 3.1.1 Functionality – Backend The backend should read data from the database and serve it to the frontend. -#### 3.1.3 Functionality – Database +#### 3.1.2 Functionality – Database The database stores the findings from the webcrawler. Also a history is stored. -#### 3.1.4 Functionality – Webcrawler +#### 3.1.3 Functionality – Webcrawler The webcrawler crawls a predefined set of websites to exctract for a predefined list of products. +### 3.2 Functionality - User Interface -#### 3.2.1 User system +#### 3.2.1 Functionality - Frontend +The User interface should be intuitive and appealing. It should be lightweight and not overloaded with features so anyone is easily able to use our service. ### 3.3 Usability We aim for excellent usability. Every person that is able to use websites like amazon should be able to use our website. @@ -183,7 +169,7 @@ IntelliJ Ultimate GitHub Jenkins -#### 3.7.4 Supported Platforms +#### 3.7.2 Supported Platforms All platforms that can run a recent browser. ### 3.8 Online User Documentation and Help System Requirements