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 […]
How to Start Writing API Technical Documentation (with templates)
September 6, 2018 By
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, […]
3 Reasons Technical Writers Should Switch To Social Media Writing
September 5, 2018 By
If you’re finding it difficult to get work in Technical Writing, then see if you can start a new career as a Social Media writer. The demand is definitely there. I found that it’s relatively easy to find contract work on Social Media sites if you’ve got good technical writing skills and know how to […]
How to Compare Two Versions of a MS Word Document (with Screenshots)
May 9, 2018 By
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 […]
Difference Between User v End User in Technical Documentation
April 17, 2018 By
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
February 27, 2018 By
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
February 25, 2018 By
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]
January 28, 2018 By
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
January 27, 2018 By
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 Technical Documents (With Screenshots)
January 26, 2018 By
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 […]
Video: 15 Technical Writing Tips
May 17, 2017 By
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
April 28, 2017 By
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
February 24, 2010 By
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?
January 12, 2010 By
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?
September 24, 2007 By
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 […]