Wie man ein gutes Changelog schreibt

Kurz gesagt, der Benutzer zu denken.

Sie lesen von oben nach unten. Sie haben eine sehr begrenzte Aufmerksamkeitsspanne. Selbst wenn sie den ganzen Weg durchlesen, sind sie wahrscheinlich zu mehr Aufmerksamkeit auf Dinge, die früh kommen zu zahlen. Vor Geduld läuft dünn.

Also Ihr Ziel ist nicht nur auf Veränderungen zu beschreiben, sondern herauszufinden, jetzt so viel Wert auf Benutzern kommunizieren, bevor sie das Interesse verlieren. Wenn Sie einen wirklich guten Job machen, könnten Sie eigentlich verhindern, dass sie das Interesse verlieren und sie werden den ganzen Weg durch zu lesen. Wetten Sie nicht auf sie aber …

Tipps

• Beginnen Sie mit den interessanten Sachen: put die wertvollsten, am einfachsten zu Veränderungen an der Spitze zu verstehen. Schieben Sie weniger interessant, technische Sachen auf den Grund.
• Zoomability Prinzip: Gruppe damit verbundenen Veränderungen im Rahmen eines zusammenfassenden Titel, der es einfacher, die enthaltenen Elemente zu verstehen ist, liefert die Motivation, um ihren Inhalt zu lesen, und Primzahlen Erwartungen.
• Weniger Annahmen: versuchen, weniger zu nehmen Bezug auf Details Nutzer sollten vertraut sein mit (zB den Namen eines Moduls). Angenommen, Sie haben ein Budget, das wie viele Details Sie können sich in Grenzen. Reserve Detail nur für die wichtigsten Dinge.
• Whitespace: add Leerzeichen, um die Struktur in Text und lassen es so aussehen weniger beschäftigt.
• Zusammenfassungen: Hinzufügen Zusammenfassungen können die Dinge einfacher, mit sehr wenig zusätzlichem Aufwand zu verstehen. Im Rahmen eines changelog kann dies so kurz wie ein Wort.

  Beispiel:

  bind postfix MTA auf localhost

  vs

  bind postfix MTA auf localhost (Sicherheit)