How to Write Release Notes: Tutorial & Template

So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]

Jane Austen on Persuasion in business writing

Jane Austen “How quick come the reasons for approving what we like.” Want to be a more persuasive writer? A few suggestions: Tap into the reader’s values. Be decisive. Don’t sit on the fence. Force the reader to take sides, hopefully with you Ask the reader a question, often framed as a dilemma. Help them […]

How to Get Meaningful Feedback After Training

What’s your reaction when you’re asked to give feedback? I expect it’s that unpleasant feeling when you feel obliged to do something, but would rather not. Most of us don’t like giving feedback. Somehow there is a negative element associated with it. However, we need feedback. Others need it too. Giving it to others helps […]

How to Write a Customization Guide

The first question is: who are you writing this customisation guide for? As a technical writer, the skill to developing a useful guide is to keep the reader in mind. Who will be reading this customisation guide? What’s the most important thing they need to know? How can I make this more helpful to them? […]

[Checklist] Document Reviews

Use this checklist to review business, medical, or technical documentation. It is recommended to review the document for start to finish for each item on this list, instead of reviewing all items as you go through the document. In other words, check that all images are correct throughout the document. Fix any errors. Then go […]