How to Hire a Technical Writer

If you want to know how to hire a technical writer, read these guidelines. 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 […]

1 Minute Writing Tip – Using Colons in Lists

In this 1 Minute Writing tip, we look at when to use colons in lists. Do you always need a colon? Would a comma do instead? When should you use one over the other. Let’s get into it. So, you want to start a list with a colon. Sounds easy, don’t it? Many writers assume […]

Difference Between User v End User in Technical Documentation

When should I use ‘user’ instead of ‘end user’ in my user guides? Let’s start with a definition of end user. Definition: Where does the phrase ‘end user’ come from? According to Wikipedia: An end user is a person who uses a product. The term is based in the fields of economics and commerce. A […]

MadCap Flare: How to Add An Image to the About Box

In this MadCap Flare technical writing tutorial, we’ll look at how to add an image to the About box in the output window. When you click the icon, your image is displayed in the corner. A nice touch and a way to highlight your brand. At Klariti, we use MadCap Flare (and Word) to write technical documents. […]

MadCap Flare: How to Create Your First Project

In this MadCap Flare tutorial, we’ll look at how to start a technical writing project. Here, at Klariti, we use MadCap Flare to write technical documentation for our clients. Contact us if we can help. Download 15 Technical Writing templates to write technical documents faster MadCap Flare: How to Create Your First Project There’s different ways […]

Proofreading & Editing Checklist for 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 […]