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, […]

Installation Guide Checklist: Sample Template For Technical Writers

In the introduction section, identity the software you are about to install, steps to prepare for installation, running installation scripts, and post-installation tasks after the installation script has completed. In general, your installation guide will include most of the following: Introduction Choose the Installation Type Concepts Setup Pre-Installation Requirements Pre-Installation Checklist Installation and Configuring Procedure […]

Writing Guidelines For Release Notes Enhancements

What do you need to include in your enhancement release notes? Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates At a minimum, you need to cover the following: Description – identify the new enhancement. Avoid the words new, enhancement, […]

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 When Writing Bugs and Enhancements

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 managers, testers, […]

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 […]

How to Write a Better System Administration Guide

What do System Administration Guides and Mozart have in common? There’s a scene in the movie Amadeus where the Emperor asks Mozart to take out the boring notes. He found it too long. “Cut out some parts here and there.” “Which notes, your Emperor?” said Mozart. The Emperor tried, got into a tangle and then […]

How to Write a Software Documentation Plan

What is a software documentation plan? This is a project plan for the technical documents you plan to write for the next software release. Like a standard project plan it captures the resources, requirements, costs, and deliverables. As this is for technical writers, the documentation plan will focus on the content you intent to deliver; […]

How to make detailed Business Process Flowcharts easier to read

Isn’t the advantage of creating process flowcharts to help the reader see how it works instead of having to read the MS Word document? But what happens if the process is so complex that the diagram becomes almost unreadable? Instead of helping business analysts understand the process, it adds another layer of complexity. In addition, […]