How to Start Writing REST or Web API Documentation

Let’s say you’ve been asked to document a set of REST or Web 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. Focus on a specific api,  for example, REST. Ignore the temptation […]

7-Step Approach to Proofreading User Guides

What can Kate Winslet teach you about proof-reading technical documents? Watch the movie The Reader and it will make sense. One of the biggest mistakes you can make when revising any technical document, is to do it all in one go. You can’t! 7 Ways to Proofread User Guides Make it easy on yourself and […]