Inhalt des Changelogs

[gboehm]

Moin zusammen,

Das Changelog lässt mich immer wieder stirnrunzelnd zurück.
Die Beschreibungen zu den Bugs sind durchaus irreführend. D.h. einmal ist der Text zu einem Bug eine Fehlerbeschreibung, ein anderes mal eine Korrekturbeschreibung.
Beispiel aus dem Wawi Changelog zur 1.0.11.1 (beides Bugs):

18040

Korrekturbuchung bei vielen Picklisten nicht mehr langsam

17447

Bilderkonvertierung konvertiert nicht alle Bilder

Bei 18040 beschreibt der Text offensichtlich die Korrektur. Bei 17447 ist es jedoch eine Problembeschreibung. Das ist irreführend und leider nicht immer so offensichtlich erkennbar ob das Problem oder die Lösung beschrieben wurde. Denn wenn beide Texte eine Problembeschreibung wären, wäre bei 18040 die Korrekturbuchung jetzt langsam. Anders herum, wenn beide Texte eine Beschreibung der Lösung wären, würden durch 17557 nun nicht mehr alle Bilder konvertiert.
Der Text sollte entweder eine Problem-, oder Korrekturbeschreibung sein - aber nicht mal so und mal so.

Oder was soll mir dieser Eintrag (Bug) sagen:

16969

Umsatzsteuer-ID bei IGL

Der Informationsgehalt dieses Bugs ist mehr als sparsam. Das ist weder eine Problem-, noch eine Beschreibung was korrigiert wurde.
Bevor ich eine neue Version produktiv setzte teste ich einige für mich wichtige Funktionen. Aber bei dem Bug 16969 wüsste ich gar nicht, wo ich ansetzten sollte.

Ich würde mir ein Changelog wünschen, welches neben der Fehlermeldung, bzw. einer kurzen Problembeschreibung auch ausführt, was behoben wurde und welche Programmbereiche davon betroffen sind.
Zu einer guten Software gehört auch eine gute Dokumentation!

 

[gboehm]

AW: Inhalt des Changelogs

Also, nun weiß ich wirklich nicht mehr, was man vom Changelog halten soll.

Als ich das Log der gerade eben released 1.0.11.3 gesehen habe dachte ich, "oha, eine ganze Menge Fixes für ein Emergency Release". Dann ist mir aufgefallen, dass es fast identisch dem der 1.0.11.1 ist.

"Fast", denn

1. fehlt mit

   18590

   Amazon-Abgleich für Bestellungen mit ausländischem Versandland funktioniert nicht

   der Fix, weswegen 1.011.2 released wurde
2. ist "16969 Umsatzsteuer-ID bei IGL" zwar im Changelog im Forum vorhanden. Dafür ist er nun hier verschwunden, wo er kürzlich noch vorhanden war
3. ist nur "16949 Amazon Lister - Unterkategorien "künstliche Fingernägel" neu hinzu gekommen.

Heißt das nun

• dass 1850 zurückgezogen wurde und der Bug wieder offen ist?
• Ist 16969 nun drin oder nicht und was verbirgt sich hinter dieser nichtssagenden Beschreibung?
• ist 16949 dann der Grund warum 1.0.11.3 zu schnell released wurde

 

[Janusch]

AW: Inhalt des Changelogs

Hallo,

danke für den Hinweis. Es handelt sich um interne Tickets, die gar nicht ins Changelog rein sollten.