search

L2P-Academy / FIAE1_RPG

7 stars 0 forks source link

Dokumentation/Wiki #146

Closed L2P-Academy closed 3 weeks ago

L2P-Academy commented 2 months ago

Es muss für alles ein Wiki erstellt werden + Überprüfung der Code-Kommentare, ggf. Refactoring -> In das Wiki sollen Code-Conventions eingepflegt werden

L2P-Academy commented 1 month ago

Gliederung für Wiki:

  1. Einführung
  2. Codeconvention
  3. Klassenstruktur
  4. Datenbank (Tabellen + Spalten + Beziehungen)
  5. Anforderungen
  6. Ressourcen
  7. Schnittstellen / Bibliotheken / Plugins
  8. Programmablauf (Grafik / Zustandsdiagramm)
  9. Tutorial
  10. Testdokumentation
  11. Lizenz (Nutzung/Verbreitung etc)
  12. EULA
  13. Quellenangaben
  14. Special Thanks
  15. AI-Generated Content
L2P-Academy commented 1 month ago

Codeconvention mache ich

christian-gassmann commented 1 month ago

Datenbank mache ich

weirdmustard commented 1 month ago

Komm, ich mach Lizenz und Standard-EULA anpassen, ich kann mich auch mit um die Quellenangaben kümmern, wenn wir denn welche haben. Muss mir nur jeder der was (unter CC Lizenz oder so) einbaut jeweils Bescheid geben.

Rakinos89 commented 1 month ago

Klassenstruktur und Programmablauf (Grafik / Zustandsdiagramm) mache ich

weirdmustard commented 1 month ago

Joa, dann mach ich heut Nachmittag noch die Ressourcen-Seite

weirdmustard commented 1 month ago

Aktuell noch zu tun:

[3. Klassenstruktur] [5. Spielmechaniken] [7. Schnittstellen / Bibliotheken / Plugins] [10. Testdokumentation] [8. Programmablauf]

weirdmustard commented 1 month ago

Aktuell noch leere Wiki-Seiten:

Klassenstruktur Spielmechaniken Schnittstellen, Bibliotheken & Plugins Programmablauf & Testdokumentation

@Rakinos89 Du wolltest die Programmabläufe auch als Diagramm darstellen, das kommt jetzt mit bei 8. rein, L2P meinte, das ist alles Testdokumentation