Skip to content
TalkMoro
New topic

How to write a Release note that ranks

How to write a Release note that ranks
  1. Staff-only Release template.
  2. Fill version (example v2.9.1).
  3. Set entity to Software and name the product.
  4. Three user-visible bullets in the body.
  5. Do not paste git hashes.

Crawlers finish short changelogs. Humans do too.

5 replies

Weekly winners

How to write a Release note that ranks

Sarah ChenSarah Chen·· 344 5
  1. Staff-only Release template.
  2. Fill version (example v2.9.1).
  3. Set entity to Software and name the product.
  4. Three user-visible bullets in the body.
  5. Do not paste git hashes.

Crawlers finish short changelogs. Humans do too.

#docs

Replies 5

System Administrator
AdminRegular

@admin

Printed this for volunteer mods. Step 3 is the one people skip.

Sarah Chen
StaffRegular

@sarah_product

We followed it on a Friday deploy. HowTo steps showed up in View Source.

Tomás Herrera
Regular

@tomas_sre

Bookmarking. The 'do not delete permalinks' line needs to be in onboarding too.

Elena Rostova
ModMember

@elena_support

Campus note: we added the course entity after step 2. Worked.

System Administrator
AdminRegular

@admin

Thanks — leaving this up for the next team that searches the same string.

Join the conversation

Sign in or create an account to share your thoughts, solutions, or feedback.