How to Write an Operations Plan (with Word Template)

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. The Operations Guide Template will help you run your IT environment more efficiently. It […]

MadCap Flare: Changing the Pane Position and Size in WebHelp

In this MadCap Flare technical writing tutorial, we look at how to change the pane position and size in WebHelp. Changing the Pane Position and Size in Webhelp In Flare, you can change the width of the pane in your web help as well as its position. Open a Standard or HTML5 skin and select […]

How to Write ‘Scannable’ Web Content

Need to improve your web content? How much words should I put on a web page? How do I present the material? How do I know that anyone reads it? Research suggests that users don’t read on the web –  they scan. This means that when you are converting documents to the web, you need to […]

11 Examples of REST API Documentation

Looking for examples of API documentation online? Wondering how the big boys write their API documentation so you can get a little inspiration? Me too. //Get the REST API Documentation Tutorial here We’ve being writing a lot of API documents recently for a new client. She asked for examples of how other IT companies publish […]

22 API Document Generation Tools

Want to document your Web and RESTful APIs but don’t know where to start? Me too.  APIs are great but they also need documentation. I did a bit of hunting and compiled this list. It’s in no particular order of preference. I sorted them A-Z. [Get the API Documentation Template here] 21 API Documentation Tools […]

NEW – Quality Assurance Plan Templates (MS Word + Excel)

This week we created a new set of Quality Assurance Plan Templates. I sat templates as we developed more than just the MS Word template, but sample materials, and also seven pretty slick Excel spreadsheets. If you’re involved in tech writing or software testing, I think these templates will be of real value to your Quality […]

5 Ways to Write Better Error Messages

When you write error messages for software development projects, follow these guidelines: Avoid vague wording. Give specific names and locations of the objects involved. Avoid “please.” It can be interpreted to mean that a required action is optional. Do not refer to implementation details that are invisible to the user. For example, do not refer […]

Error Messages: Do’s and Don’ts

Looking for guidelines to write better error messages? Do’s and Don’ts when writing error messages: Don’t Avoid the word “bad”. Use more descriptive terms to tell the user what is wrong. For example, avoid messages such as “Bad size”. Instead, tell the user what criteria to use when specifying a size. Avoid the word “please”. […]

How to Write Error Messages

Here’s a suggested approach to writing error messages: Create a spreadsheet. Give each error a number so you can track them. Add columns for the error message and the root cause. Establish an error message quality-control team. Create simple to follow writing guidelines for the error messages. Find best practices. Share with the team. Include […]

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