Tag Archives: Technical Writing

User Story – Writing Guidelines and Checklists

In this week’s technical writing tutorial, we look at how to write a user story. You can use these guidelines and checklists to refine your user stories, expand the material to help your readers understand the scenario, allow developers to code the requirement, and testers to ensure it meets the acceptance criteria. Let’s get started.

How to Start Writing API Technical Documentation (with templates)

API documentation template

Let’s say you’ve been asked to document a set of APIs, a new area for you. Where do you start? At first this can seem overwhelming. So many new acronyms, terms, jargon, and pieces to fit together. Here’s a suggested approach. DOWNLOAD API Reference Documentation Template Get API Reference Documentation Template If your company develops APIs, […]

How to Compare Two Versions of a MS Word Document (with Screenshots)

In this tutorial we show how to compare two versions of the same Word document so we can see what changes were made to each document. After comparing the documents, Word shows the differences with revision marks. Knowing how to compare documents can be very useful, for example, when reviewing documents submitted by different writers. Quite […]

How to Create an Index in MS Word [Beginner’s Tutorial]

In this tutorial, we look at how to create an index in MS Word. We also explain how to prepare your Word document before you start indexing, the correct way to index items, how to delete an index entry, and how to update the index after you have made changes. Ok, let’s start. So, you’ve […]

How to Create an Index for Technical Documents (With Screenshots)

Is an index old fashioned? With everything on the web, do you even need an index? The first thing. Not everything’s on the web. The second: What’s not on the web often needs an index to direct the reader to relevant content. The third: A good index makes good content even better. It won’t save poor writing […]