Writing Release Notes
Minimum price
Suggested price

Writing Release Notes

Instructions, examples, and templates for quick results.

About the Book

A clear explanation of what to say and how to say it, with examples and templates that make it easy.

  • Share this book

  • Categories

    • Technical Communication
  • Feedback

    You must own a copy of this Book to access the forums.

    Email the Author(s)

About the Author

Rolfe Dlugy-Hegwer
Rolfe Dlugy-Hegwer

As a Senior Technical Writer at Red Hat, my goal is to improve, reinvent, and transform technical communication.

Table of Contents

  • Introduction
  • A few terms worth knowing
  • Example: The release notes for Apple’s iOS & iPadOS SDK
  • Writing release notes
    • Enhancement
  • Bug fix
  • Known issue
  • Technology preview
  • Deprecation and removal
    • Improve this book
    • Q: What is a release note?
    • Q: What is the number you see in some release notes?
    • Q: Who reads release notes and why?
    • Q: What are the basic types of release notes?
    • Q: What are some different ways to organize release notes?
    • Q: How should I organize my release notes?
  • Additional content
  • Backmatter
    • About me
    • Writing style
    • Dedication
    • Acknowledgements
    • License
  • Answers to Exercises

The Leanpub 60-day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

See full terms

80% Royalties. Earn $16 on a $20 book.

We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earnedover $12 millionwriting, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub