commit 7c4b0bc9a51663ce5f309761fa1a67e40ad6955c Author: Patrick Müller Date: Thu Oct 15 10:18:56 2020 +0200 Initial commit diff --git a/SRS.md b/SRS.md new file mode 100644 index 0000000..561ac20 --- /dev/null +++ b/SRS.md @@ -0,0 +1,201 @@ +# littleBeasts - Software Requirements Specification + +## Table of Contents + +- [Flashcard Community - Software Requirements Specification](#flashcard-community---software-requirements-specification) + + - [Table of Contents](#table-of-contents) + + - [1. Introduction](#1-introduction) + + - [1.1 Purpose](#11-purpose) + - [1.2 Scope](#12-scope) + - [1.3 Definitions, Acronyms and Abbreviations](#13-definitions-acronyms-and-abbreviations) + - [1.4 References](#14-references) + - [1.5 Overview](#15-overview) + + - [2. Overall Description](#2-overall-description) + + - [2.1 Vision](#21-vision) + + - [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.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.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) + + - [3.5.1 Response time](#351-response-time) + - [3.5.2 Throughput](#352-throughput) + - [3.5.3 Capacity](#353-capacity) + - [3.5.4 Resource utilization](#354-resource-utilization) + + - [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.8 Online User Documentation and Help System Requirements](#38-online-user-documentation-and-help-system-requirements) + + - [3.9 Purchased Components](#39-purchased-components) + + - [3.10 Interfaces](#310-interfaces) + + - [3.10.1 User Interfaces](#3101-user-interfaces) + - [3.10.2 Hardware Interfaces](#3102-hardware-interfaces) + - [3.10.3 Software Interfaces](#3103-software-interfaces) + - [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 + +### 1.1 Purpose + +### 1.2 Scope + +### 1.3 Definitions, Acronyms and Abbreviations + +| Term | | +| -------- | ----------------------------------- | +| **SRS** | Software Requirements Specification | +| **JSON** | JavaScript Object Notation | +| **API** | Application Programming Interface | +| **MTBF** | Mean Time Between Failures | +| **MTTR** | Mean Time To Repair | +| **DTO** | Data Transfer Object | +| **HTTP** | Hypertext Transfer Protocol | +| **FAQ** | Frequently Asked Questions | +| **REST** | Representational State Transfer | + +### 1.4 References + +| Title | Date | +| ----------------------------------------------------------------------------------------------------- | ---------- | +| [Blog](https://flashcardcommunity.wordpress.com/) | 17/10/2018 | +| [GitHub](https://github.com/phoenixfeder/fc-com/) | 17/10/2018 | +| [Spring Boot](https://spring.io/projects/spring-boot) | 19/10/2018 | +| [ReactJS](https://reactjs.org/) | 19/10/2018 | +| [Use Case Diagram](https://github.com/phoenixfeder/fc-com/blob/master/FlashCardCommunityUseCases.png) | 21/10/2018 | + +### 1.5 Overview + +## 2. Overall Description + +### 2.1 Vision + +## 2.2 Product perspective + +### 2.3 User characteristics + +### 2.4 Dependencies + +## 3. Specific Requirements + +### 3.1 Functionality – Data Backend + +#### 3.1.1 Read data given over API endpoints + +#### 3.1.2 Parse data + +#### 3.1.3 Provide data + +### 3.2 Functionality – User Interface + +#### 3.2.1 User system + +#### 3.2.3 Flashcard boxes + +#### 3.2.4 Flashcards + +#### 3.2.5 Statistics + +### 3.3 Usability + +### 3.4 Reliability + +#### 3.4.1 Availability + +#### 3.4.2 MTBF, MTTR + +#### 3.4.3 Accuracy + +#### 3.4.4 Bug classes + +### 3.5 Performance + +#### 3.5.1 Response time + +#### 3.5.2 Throughput + +#### 3.5.3 Capacity + +#### 3.5.4 Resource utilization + +### 3.6 Supportability + +### 3.7 Design Constraints + +#### 3.7.1 Development tools + +#### 3.7.2 Spring Boot + +#### 3.7.3 ReactJS + +#### 3.7.4 Supported Platforms + +### 3.8 Online User Documentation and Help System Requirements + +### 3.9 Purchased Components + +### 3.10 Interfaces + +#### 3.10.1 User Interfaces + +#### 3.10.2 Hardware Interfaces + +#### 3.10.3 Software Interfaces + +#### 3.10.4 Communications Interfaces + +### 3.11 Licensing Requirements + +### 3.12 Legal, Copyright and other Notices + +### 3.13 Applicable Standards + +## 4. Supporting Information