Aufbau von Changelog oder Relase Notes
Ziel
Ich verstehe, wie man Nutzer_innen über Änderungen an einer Software informiert.
Hintergrund
Früher wurden mit jeder neuen Version einer (ordentlichen) Software so genannte "Release Notes" herausgegeben, die mehr oder weniger genau beschrieben, was sich geändert hat.
Heute haben sich im Open-Source-Bereich schlanke und etwas besser standardisierte Formate für den gleichen Zweck herausbildet, bei denen das Dokument meistens CHANGELOG (also "change log", Protokoll von Änderungen) genannt wird.
Da man sowas tunlichst auch selber führen sollte, wenn man Software entwickelt (selbst, wenn es nur für persönliche Zwecke wäre), wollen wir uns hier damit vertraut machen.
Arbeitsschritte
Wissen anlesen
Arbeiten Sie https://keepachangelog.com/de/1.0.0/ durch.
Mit Realität vergleichen
- Betrachten Sie das Changelog von freezegun.
- 1 Nennen Sie einen Aspekt, der Ihnen daran gut gefällt
- 2 und einen zweiten, der verbesserungswürdig wäre.
- Betrachten Sie das Changelog von Django. Django ist ein weitaus älteres und viel größeres Projekt als freezegun. Äh, wo haben die denn überhaupt das Changelog?
Hinweis (nur bei Bedarf): Ort des Django-Changelogs
GitHub: docs/releases
Gerendert: https://django.readthedocs.io/en/stable/
Reflektion darüber
- 3 Warum benutzt Django wohl diese Form?
- 4 Angenommen, Sie entwickeln eine Webanwendung mit Django, die derzeit
mit Django Version 4.1.7 läuft und wollen jetzt ein Upgrade auf die
Version 5.0.4 machen.
Welche Dateien müssen Sie studieren, um die wichtigsten Dinge (nicht jede Einzelheit) zu überschauen, die bei dieser Umstellung schiefgehen könnten und vielleicht Änderungen an Ihrer Webanwendungen verlangen? Welche Abschnitte in diesen Dateien müssen Sie beachten? - 5 Welche Abschnitte in welchen Dateien brauchen Sie zusätzlich, wenn Sie auch noch tolle neue Funktionalität mitbekommen möchten, die Sie vielleicht in Ihrer Webanwendung benutzen wollen?
- 6 Inwiefern ist dieses Format bei Django gut? Wäre ein normales Changelog besser?
Abgabe
Geben Sie ein Markdown-Dokument ab mit knappen Antworten zu den oben gestellten Fragen
1, 2, … Geben Sie diese Marker mit an.
Geben Sie ggf. Beispiele oder benutzte Quellen an.