A release note gets opened by someone deciding whether to upgrade, long after whoever wrote it has moved on to the next version.
Release 4.8
Exports now run in the background and land in your inbox. Two long-standing sorting issues are fixed. The full list follows.
Sorting by owner no longer resets on refresh; exports of documents over two hundred pages complete instead of timing out.
Each version needs its own dated entry, with the one that shipped in November never blending into the one that shipped in December. A command that changed, a screenshot of the new screen, and a link to the pull request behind it can all sit inside that one entry, dated and headed the same as every other version. The same page should keep answering that whether it's opened the day it ships or a year later, at the same address it always had.
Each version dated and set apart from the ones around it
Every entry carries the date it shipped under its own heading, so a version can be found and pointed to on its own instead of counted back to from the newest one.
History that folds away until someone wants it
An older version's entry can close beneath its own heading, so the page opens on what's new instead of a year of entries stacked one after another.
One link, kept as long as you keep it
A share link for the release notes has no expiry set unless you add one, so the same address can be bookmarked once and stay correct release after release, right up until you decide to revoke or replace it.
Which version people actually open
You see how often the page gets opened after each release goes out, and which entry, by its own heading, holds a visit the longest — the newest one, or one further back in the history, the sign of whether this update needed the explanation or an older one still does.
An example — not your document. Sections are the document’s own headings.
Most of their attention went to “Commands” — 2m 33s of 4m 00s. They came back to “Details”.
Time each section spent on screen, counted only while the tab was in front and the reader was active. It shows what was in front of them, not what they read.
This page is about what a release notes has to do. For the blocks the editor is built from — see the editor.
Not unless you set an expiry yourself — by default a share link stays valid until you revoke it, so the same address keeps working release after release.
Not directly — resize and align the image on the page, but there's no separate caption field. Describe the change in the text beside it instead.
Not yet — start from a blank page; a dated heading, a folding entry for the version before it, and a link that keeps working all work from the first release you write up.