Release Notes: 7 Steps to Better Enhancements

Want to improve the quality of the enhancements in your Release Notes? Here are seven ways. Enhancement Identifier Provide the reference number for the enhancement, such as Salesforce 12345. Business value Describe the benefit to the user if they use this enhancement. Usually, there is a specific business driver or customer request behind each enhancement’s […]

Context Sensitive Help: 13 Ways to Test and Improve

After writing the Content Sensitive Help, create a test plan to check that the Help works correctly. Before you start testing the Content Sensitive Help: Clear the cache. Open Excel to log errors. Don’t test your own work. How to Test Content Sensitive Help Use this checklist to test the Content Sensitive Help: F1 — […]

How to write documents for SaaS web applications

SaaS and web-based applications are becoming more popular as they replace desktop or network installations. How you document them is mostly the same as documenting traditional but there are some difference. Let’s take a look. Registration – explain how to set up the account, register an account, common setup issues, and troubleshooting, for example, if […]

How to Perform a ‘Post Mortem’ on Technical Documents

After every major release, do a post mortem of your technical documentation and look at how you can improve team morale, writing process, document reviews, and the documentation product. Post-mortems focus on two areas Quantitative data — such as, the difference between the project estimate and the hours worked. Qualitative data — such as, satisfaction, […]

How to write Enhancements for Release Notes

What do you need to include in your enhancement release notes? At a minimum, you need to cover the following: Description – identify the new enhancement. Avoid the words new, enhancement, or feature in the title. You can drop these words as it’s implied that it’s an enhancement as it’s in the Enhancement section of […]

Release Notes: Sample Text for Writing Enhancements

An enhancement is a new feature, or an improvement to a current feature, included in the current release. To help the reader understand the enhancement, describe: Where the enhancement is located in the user interface. What parameters need to be configured. What is the default setting. Why you should use this enhancement, for example, a […]

Release Notes – How to Write ‘Known Issues’

This week we look at how to document known issues in release notes. The Release Notes web page on the NuGet site offers good examples of how to document known issues in release notes. We’re going to look at three common issues: Installation issues Known issues Workarounds Let’s see what we can learn from it. […]

Release Notes: 13 Mistakes to Avoid

It’s easy to overlook the importance of release notes. But when customers want to know exactly what a specific parameter does, it’s the release notes that often turn too. Why? Remember, for very large document sets, it can hard to know which document contains the reference material you need to understand. For this reason, configuration […]

Difference Between SOPs v Work Instructions v Procedures

How can you tell if a document is a SOP, Procedure, or Work Instruction? Also, what are the connections between each of these documents? Is one more important than the other? Do you need to write an SOP before the Work Instruction… or should it be the other way round? Download Work Instruction Templates for […]

Operations Plan: The Definitive Guide

Want to write an Operations Guide? This tutorial explains how to write your first operations manual. It helps you get started, suggests how to format the document, create the table of contents and what else you need to include in a sample plan. Operations Guide: Definition What is an Operations Guide? Definition: An Operations Guide […]