3 ms·
> release notes 4doc's contribution here is to ask you who the audience is for your release notes. Is it task-oriented, e.g. release notes for a database to he
by solatic 3y ago
> release notes
4doc's contribution here is to ask you who the audience is for your release notes. Is it task-oriented, e.g. release notes for a database to help DBAs upgrade to that new version? Then write your release notes in a how-to style. Is it understanding-oriented, e.g. release notes for new B2C product features, to help users understand what it is you built? Then write your release notes in an explanation style. Different products have different requirements from their release notes, but 4doc helps you conceptualize who is supposed to benefit from it and therefore what style (and organization, and delivery) will be most beneficial when writing them.
The worst release notes are auto-generated from Git commits, in projects where Git commit messages are basically jotted-down handwritten chicken-scratch that are not really intended nor edited for external consumption. 4doc points out to you that autogenerating the release notes from commit messages like that is basically beneficial to nobody.
- kaycebasques 3y agoYes, that is a helpful framing and is aligned with how I approach release notes in practice. It really boils down to thinking in modes of documentation (learning, understanding, tasks, information), not doc types. Release notes can and should be "instantiated" in different modes depending on audience needs. Release notes probably don't hint at a new mode.