The bigger picture

Most enterprise software companies write up a special Release Notes document to accompany a new version of their product. The majority of Release Notes that I have come across are filled with the obligatory "fixed bugs" and "new features" lists.

I know for a fact that most customers do read Release Notes. They need to in order to check for bug fixes that impact their implementation or to learn about features that might help their users.

What a great opportunity to shine a spotlight on your application, regardless of what's new or fixed?

Who says the Release Notes have to be exclusively about that release? Why not emphasize new features in the context of existing ones? Or highlight fixed bugs and how they now allow for increased productivity in your product.

In other words, give the facts but don't miss an opportunity to show your customers the bigger picture.

Recipe for success

I enjoy cooking and I wonder if it has anything to do with the comfort of the documentation involved.

Documentation for cooking = RECIPE.

I can honestly say that, without the reliable format of the common recipe, I would neither excel at nor enjoy cooking.

According to my friendly neighborhood etymologist (http://www.etymonline.com), the word recipe was originally used by physicians who wrote it at the head of prescriptions. It meant  "instructions for preparing food". So, there is no question that these instructions needed to be both precise and concise. 

Look at any recipe today and you'll most likely find the following elements:

There is a title: what you will be cooking

There is a list of ingredients: what you will need in order to cook it

There are the steps of preparation: how you will cook it

Isn't simplicity delicious?