Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dokumentation Überarbeiten #227

Open
15 tasks done
Tuckerle opened this issue Feb 22, 2024 · 1 comment
Open
15 tasks done

Dokumentation Überarbeiten #227

Tuckerle opened this issue Feb 22, 2024 · 1 comment
Assignees
@Tuckerle @danielnwz
Labels
documentation Improvements or additions to documentation

Comments

@Tuckerle
Copy link
Contributor

Tuckerle commented Feb 22, 2024 •
edited by danielnwz
Loading

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
@Tuckerle Tuckerle added the documentation Improvements or additions to documentation label Feb 22, 2024
@IamPekka058
Copy link
Contributor

Ich habe folgenden Bug gefunden:

@Tuckerle Tuckerle self-assigned this Mar 1, 2024
@danielnwz danielnwz self-assigned this Mar 5, 2024
@danielnwz danielnwz mentioned this issue Mar 7, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Tuckerle Tuckerle

@danielnwz danielnwz

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@IamPekka058 @Tuckerle @danielnwz