Create project documentation

  • Beschreibung
  • Wie wird Projekt gestartet
  • known issues?
  • Anforderungsanalyse
  • Use Case Diagram
  • UML Diagram
  • Dokumentation des Codes und Architektur: Dokumentiert wie Komponenten miteinander kommunizieren. Dokumentation der architektonischen Entscheidungen mit Hilfe von ADR (Architecture Decision Records, mind. drei). Code-Dokumentationsprinzipen beschrieben und angewandt (nicht erlaubt: Begründung "der Code ist selbsterklärend")
  • git-Vorgehen inkl. branching dokumentiert und angewandt
  • Dokumentation der Schnittstelle: Doku der Operationen, warum welche Schnittstellenart (synchron/asynchron) eingesetzt?
  • gitlab-ci.yml so angepasst, dass manche Steps nur bei Bedarf ausgeführt werden. Inkl. Dokumentation mit Begründung
  • Reflexion was man anders machen würde
Edited by Föll Jonas