Week 10 (2024 KW 16, 15.04.24-21.04.24) - Bessere Dokumentation

[benedictweis]

Aktueller Status: 🟩

Dokumentation der nächsten Generation! Die Duogradus Dokumentation erhält ein großes Update. Unter docs.duo-gradus.de lässt sich die neue Dokumentation abrufen.

✅ Was ist diese Woche passiert?

• Es wurde an einer einheitlichen Logging Lösung gearbeitet Logging-Konfiguration #92
• Die Documentation wurde komplett überarbeitet Docs vs Wiki #108 Use Vitepress for serving all documentation #113 Swagger Client #118
• Viele kleine fixes Docs link aktualisieren #119 Another fix for the directory issue #117 ...
• Github Actions verbessert (eigener Runner)

👣 Was sind die nächsten Schritte?

• Dokumentation verbessern Docs vs Wiki #108
• Kategorien in die Time Tracking Statistiken einbauen
• [Meta] (gesprochene) Sprache die im Projekt verwendet wird #96 endlich in die Dokumentation schreiben
• Github Projekt verbessern
• Zukünftige Planung verbessern
• Activities in den Time Tracking Statistiken 😡 (komplizierter als gedacht)

🤺 Was waren/sind eventuelle Hindernisse?

• Fast keine freien Nachmittage zum Arbeiten
• Noch keine Zeit gemeinsam die neue "Anforderung" zu besprechen, bisher ist der Gedankengang aber "Anforderung verwerfen" 😁

💡 Was waren die Erkenntnisse dieser Woche?

• Die gesamte Dokumentation direkt neben dem Code abzulegen ist sehr effizient
• Manchmal ist einfach mal Arbeiten auch effizient, Hackathon style 😉
• Die bisherige Dokumentation hat viele Lücken und ist unvollständig, das wird mit dem neuen System hoffentlich besser
• Eventuell sollten die Statusberichte auch in die Dokumentation