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

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

MadCap Flare: Displaying Navigation Links in WebHelp Standalone Topics

In this MadCap Flare technical writing tutorial, we look at how to add a navigation link to the top or bottom of topics in HTML5, WebHelp, WebHelp AIR, or WebHelp Plus outputs. This link is not displayed unless the output topic is opened as a standalone. If you click the link, you can view the […]

How to Create an Index for Business or Technical Documents

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

Video: 15 Technical Writing Tips

In this video Ivan shares 15 ways to improve your technical writing. He shows how to design better documents, perform better peer reviews, and write that little bit faster… without reducing the quality of your documents. If you have a question, please leave it on the YouTube channel. 15 Technical Writing Tips Our User Guide […]

How to Write Your First Technical Documentation Plan

Use the following guidelines to plan, schedule, and writer the user and support technical documentation for your next software product. Examples of this documentation include user guides, admin manuals, online help, and release notes. Preparing a Documentation Plan involves several different activities. Let’s examine what’s involved. Work Breakdown Structure Template [Learn more about this template here] Depending on the complexity […]

How to Write Technical Documentation for Chinese Customers

Summary: Writing technical and business documents for Chinese customers requires an understanding of loan words, proficiency levels, and reader’s expectations. [Learn more about this User Guide and Technical Writing Templates] How to Write Technical Documentation for Chinese Customers Carsten Mende explains how loan words are used in China and Japan. These are English words that […]

How Many Hours Per Week Do Technical Writers Spend Writing?

How much time do you spend writing every week? Remember, you have 37.5 hours (I know!) for technical writing every week, but how much is actually spent writing? When I say writing I actually mean developing content, so this includes illustrations, diagrams, publishing etc – whatever goes into the final deliverable.

What is a Technical Writer?

Technical writers write technical documents that explain complex issues in simple, plain English. Technical writers – also know as Technical Authors or Information Designers – write material that supports software and hardware systems. They design, write and produce material that is delivered in print, soft-copy or as Online Help, such as that found in the […]

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

Autocorrect: How to fix errors in MS Word

Here’s a quick tip to AutoCorrect errors as you type in Word: Capitalization options – AutoCorrect can capitalize the first word in a sentence, the names of days of the week, the first letter of text in a table cell, and so on. AutoCorrect entries – AutoCorrect can use a list of built-in corrections, called […]