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

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

The Definitive Guide to Writing Error Messages

These guidelines will help you write error messages that are easy to update and useful for customers. Error messages are the first line of customer support. Poorly written error messages increase technical support costs. A well-written error message tells you, the user, the following: What has happened Why has it occurred How it impacts you, […]

Sample Website Installation Plan

The following guidelines explain how to install a website application. Getting Started It is recommended that you install and verify the software in your test environment prior to deploying it to your production environment. Warning – When specifying an existing database as the installation target, this install process will replace that existing database. Be sure […]

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

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

Documentation Plan: Which Technical Documents should I write first?

Documentation plans – where do you start? Which technical document should you first write when starting to a new tech docs project? KB emailed me this question. When starting as a technical writer, it can be hard to know where to start writing, especially if many people have different documentations needs. Here’s how to get […]

Recover Text From Any Corrupted MS Word Document

Even if your MS Word documents gets corrupted, you can still repair it in Word. Here’s how. If a Word document will not open and you need to get a copy of the text within the document, try the following steps. This will help you recover the text in the document, though you may need […]