What Makes a Good Changelog - Zeno Rocha, Herbert Lui, WorkOS

This resource first appeared in issue #92 on 17 Sep 2021 and has tags Managing A Team: Documentation/Writing, Technical Leadership: Software Development

What Makes a Good Changelog - Zeno Rocha, Herbert Lui, WorkOS

A very pragmatic about documentation for developers. The most important thing about changelogs is that they exist. And the easiest way to ensure that’s done is to have simple, clear, and non-onerous expectations of what they should look like.

Rocha and Lui specify:

  • They should be clear
  • In images, highlight changes
  • Spotlight the people behind the product
  • Consistent formatting of versions and dates, and…
  • Teams should dedicate real technical staff time to them
<<<<<<< HEAD
======= >>>>>>> c1d069a... First pass at category pages