Diese Seite
Ein Changelog, unter /changelog und aus der Fußzeile verlinkt. Jedes Release und dazwischen die Änderungen, die es wert sind, genannt zu werden — gelesen aus einer einzigen typisierten Liste und dargestellt von dem Konverter, den das Produkt verkauft.
Ein Changelog ist nur dann brauchbar, wenn man dem trauen kann, was nicht darin steht. Also: was einen Eintrag bekommt.
Was hineingehört
Alles, was jemand bemerkt, der TransformPipe benutzt: eine Konvertierung, die es vorher nicht gab, eine neue Seite, ein weiterer Weg zur Anmeldung, eine verschobene Grenze, ein Fehler, der sichtbar falsch war. Ein getaggtes Release trägt seine Versionsnummer; das meiste ging zwischen den Tags hinaus und trägt keine — deshalb ist die Liste länger als die Liste der Releases.
Was nicht
Umbauten im Code, Abhängigkeiten, Build- und Infrastrukturarbeit — alles, was von außen unsichtbar ist. Der Hinweis oben auf der Seite sagt das, und genau deshalb muss es stimmen: ein Eintrag über eine verschobene Datei würde diesen Hinweis zur Lüge machen, und ein Changelog, das man erst filtern muss, liest man irgendwann nicht mehr.
Eine Liste, mehrere Orte
Jeder Eintrag kommt aus einer einzigen typisierten Liste im Repository. Die Seite, die fünf vorgerenderten Sprachen, das lastmod in der Sitemap und die Handvoll Einträge mit eigener Seite lesen alle daraus — es gibt keine zweite Datei, die mitgepflegt werden müsste, und keine, die man vergessen kann. Die Texte sind Markdown und werden von dem Konverter des Produkts selbst gesetzt: eine Release-Notiz, die den Renderer bricht, würde auch das Dokument einer Kundin brechen, und hier fällt es besser auf.
Englisch, mit Absicht
Der Rahmen ist übersetzt — Überschrift, Vorspann, die Jahresleiste und die Daten und Monatsnamen, die Intl in Ihrer Sprache setzt. Die Einträge selbst nicht. Fünf Übersetzungen pro Eintrag, pro Release, auf Dauer sind ein Aufwand, den man nach dem zweiten Release sein lässt, und ein Changelog, in dem drei Sprachen fehlen, ist schlechter als eines, das ehrlich englisch ist. Wo ein Eintrag sich eine eigene Seite verdient hat, kann diese Seite übersetzt werden — davon gibt es eine Handvoll und nicht eine pro Release.
Weiter: Release Notes aus Markdown und Dokumentation, die im Repository lebt.