Dokumentation Überarbeiten #227
Description
Die Dokumentation soll überarbeitet werden, damit alle Aspekte der Applikation abgedeckt und gut dokumentiert sind.
Das ist notwendig um eine saubere Übergabe zu gewährleisten.
- Jedes Feature muss beschrieben sein
- Was kann es und wie wird es verwendet
- Sicherheitskonzept muss sowohl fachlich als auch technisch beschrieben sein
- Gesamtprozess der abgebildet wird muss beschrieben sein
- UI Aspekte die wichtig sind
- Möglichst deutliches Userfeedback
- Loader
- Architektur der Applikation
- [ ] Ordnerstruktur vor allem Frontend- Welche Spring profile sind wichtig
- Verwendet Technologien
- Alles was Michael in der Doku gefehlt hat
- Übersicht war schwierig, also eventuell 'Landingpage' die erklärt wo finde ich in der Doku was
- Lokales Deployment sollte so beschrieben sein, dass es ohne Vorwissen durchgeführt werden kann
- Einheitliche Sprache (Englisch!)
- Menüführung überarbeiten