Gute Praktiken zum Schreiben von Versionshinweisen

Bei Auslieferung jeder Softwareversion müssen wir einen Release-Hinweis verfassen. Zum Beispiel sind hier einige der Begriffe, die ich hinzufüge, wenn ich einen Release-Hinweis schreibe:

Veröffentlichungsdatum
Fehler behoben

Ist das genug oder gibt es noch etwas?

release

— CoolProgrammer
quelle

Dies sieht aus wie ein Duplikat von programmers.stackexchange.com/questions/66377/…

Vergiss nicht, dass neue Funktionen hinzugefügt wurden

— Ratschenfreak

Antworten:

Ich denke, das Folgende wird den guten Praktiken weichen

// Datumsbezogen

Veröffentlichungsdatum

// Feature bezogen

Features hinzugefügt
Hervorgehoben Entfernt
Funktionen geändert

// Fehler bezogen

Behobene Fehler
Ungelöste Bugs

// Abhängigkeitsbezogen

Liste der Abhängigkeiten

// Testbezogen

Unit-Testergebnisse
Akzeptanz Testergebnisse

// Versionskontrolle bezogen

Tag Hinweis
Revisionsnummer

Es lohnt sich auch manchmal, Dinge hervorzuheben, die der Endbenutzer möglicherweise in seinen Konfigurationen oder Arbeitsabläufen ändern möchte.

Die meisten Endbenutzer interessieren sich nicht für das Testergebnis. Sie erwarten eine hohe Qualität, unabhängig davon, was in der Release-Information steht.

Das Wichtigste an Release Notes ist, dass jeder zusätzliche Satz weitere 10% der Leser verliert. Daher müssen Sie genau festlegen, was Ihre aktuellen Benutzer über die Version wissen müssen.

— Md Mahbubur Rahman
quelle

Manchmal lohnt es sich auch, Dinge hervorzuheben, die der Endbenutzer in seinen Konfigurationen oder in seinem Workflow ändern möchte

— jk.

@jk. Ja, du hast recht. Ich habe meine Antwort als Ihren guten Kommentar bearbeitet.

— Md Mahbubur Rahman

Die meisten Endbenutzer interessieren sich nicht für das Testergebnis. Sie erwarten eine hohe Qualität, unabhängig davon, was in der Release-Information steht.

— Henrik

@ Henrik-Versionshinweise können jedoch für andere Benutzer als Endbenutzer nützlich sein

— jk.

Das Wichtigste an Release Notes ist, dass jeder zusätzliche Satz weitere 10% der Leser verliert. Daher müssen Sie genau festlegen, was Ihre aktuellen Benutzer über die Version wissen müssen.

— ddyer
quelle

Jede Zeile könnte 10% der zufälligen, uninteressierten (oder faulen) Leser verlieren. Für diese Leser sind Ihre Versionshinweise nicht geschrieben. Diejenigen, denen es wichtig ist, was Sie getan haben, werden sie alle lesen und sich für jede relevante Zeile bedanken - Sie müssen nur vorsichtig sein, wenn Sie Flusen hinzufügen, die wirklich in die eigentliche Dokumentation aufgenommen werden müssen.

— gbjbaanb