The Ultimate Editing Checklist for Proofreading Important Business Documents

Summary: One typo can ruin your credibility. Ensure that every business and technical document you write is fact checked, proofed for errors, and reviewed for clarity, accuracy, and comprehension. This Klariti tutorial provides a step-by-step guide to review your documents. It identifies what you need to do before you start the actual proofing, strategies to […]

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

How to Write a Preface for Technical Documents

Summary: Create a preface for technical documents to describe the scope, contents, and materials referenced in the main document. Does a document need a preface? Not always. Short documents are fine without one. However, longer documents, especially those that have changed over releases will benefit from a preface. From one angle, the purpose of the preface is to set […]

How to Interview Technical Writers

Jane R. in Texas asks for some tips on interviewing tech writers, especially when using assessment tests. Her company is about to hire their first full-time writer and they have not done this before. I’ve worked on both sides on the fence in the past, (i.e. interviewed and been interviewed) and picked up a few tings […]