[[section-introduction-and-goals]]
== Introduction and Goals

=== Requirements Overview
The module "Standby Planning" should support a user by creating a standby schedule and giving the employee (standby_user) the chance to see when he/she has a planned standby time. 
Therefore the person who make the plan has the change to define groups and functions, connect them to regions, on which he/she can filter to switch standby times, for example.
Also the user has the change to start an automatic generation process in the planning phase were he/she can choose a standby cycle that defines to which times an standby time start or ends.
The full requirements of the module are specified in the external specification. 

=== Quality Goals
The following documents contain the quality goals in detail:

* Architecture Committee Handbook v1.3.1 from 05-09-2017
* Quality Committee Handbook v1.1.1 from 11-09-2017

The architecture is based on the AC-Handbook. The quality demands are described in the QC-Handbook.
Both specifications were fully complied with in the project, so that a high quality is given.

The code quality regarding static code analysis and unit test code coverage on the backend and fronend sides
are ensured by the use of sonarqube. The rule set and the qualtity gate are defined by the default, the
so called "sonar way".

The module 'Standby Planning' is part of the Eclipse project 'Eclipse openK User Modules'.
This project bases on the Eclipse Public Licence 2.0.


=== Stakeholder
.Stakeholders
[options="header"]
|=========================================================
|Role/Name|Contact|Expectations
|Product Owner (represents the Distribution System Operators)|Oliver Frank, Heinrich Schubert|The software must fulfil their functional and nonfunctional Requirements.
|Module Developer|Maximillian Ridder, Christoph Weber, Markus Wolf|All relevant business and technical information must be available for implementing the software.
|External Reviewer (represents the AC/QC)|Thorsten Meyer|The software and the documentation is realized according the Quality and Architecture Handbook of openKONSEQUENZ.
|External Reviewer (represents the Eclipse-Requirements)|Angelika  Wittek|The software is  licensed under the EPL 2.0. It must be validated that all requirements are fulfilled.
|System Integrator|n.n.|A documentation for the integration of the module in the DSO specific environments must be available.
|=========================================================