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

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

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

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

How to Write Your First Test Case

One of the difficulties in writing your first test case is that it’s hard to know where to start. Writing test cases is not that difficult if you understand who you’re writing for and what you’re hoping to achieve. What’s the purpose of a test case? The purpose of a test case is to: Describe […]

The 10 Commandments of Software Maintenance Plans

What’s the best way to write a Software Maintenance plan? Software Maintenance Plans are different than other technical documents in that the focus is on how to modify software AFTER it has been released and is now in operations. Most other documents focus on planning, development or testing. Download Now How to Write Software Maintenance […]

How do you know whether you’re writing well?

How do you know whether you are writing well? There’s only one test that really matters: when your audience understands your information and is moved to act in accordance with your goals. But how will you know when this happens? The odds are pretty good that, early in your career anyway, you won’t have any […]