Madcap Flare: Logo Size and Settings for WebHelp

Want to replace the default MadCap Flare logo for your online help? Before you do, a few things to consider: For IE 6 or older uses — save the logo as GIF with a transparent background. If you use PNG, the transparent portion of your image appears as black. For IE 7 or newer — […]

Web Help: 5 Index Guidelines

Do you provide an index for your online documents? I’m not sure if today’s customers actually want an index. Maybe they prefer to search. Of course, not everyone agrees with me. Lori Lathrop, author of An Indexer’s Guide to the Internet, helps firms index their technical publications for software, manufacturing, and science. She highlights four […]

Robohelp: Why Short Topic Names Improve Navigation

The length of the topic title, i.e. the number of characters, needs to be considered when creating topics for online help. Let’s say you’re creating different topics in RoboHelp. Procedures, reference, and conceptual materials. Each of these needs an intuitive and meaningful name. That makes sense. However, you also need to consider the length of the topic […]

Does your technical writing have an accent?

Maybe you don’t hear your accent, but others do. When you read their documents, does the accent come through?

Are technical documents a waste of time?

“Don’t worry” she said. “No one reads this stuff anyway. Just get it done.” Sounds familiar?

How to Write a Target Audience Questionnaire

Creating a training plan? Before you do this, you need to step a step back and work out what your colleagues need to learn.

Favorite 10 Technical Writing Tools

I’ve used the same technical writing tools for the last 5 years. A few products have come across my desk but nothing that really blown me away. Here’s a run-down of what I use to write my technical documents. No order of preference. Which should I keep? Which should I replace?

Robohelp vs Doc-to-Help? Which is best for Online Help?

Robohelp or Doc-to-Help? My client has given me permission to use whatever tool I want to do the next batch of tech docs — and they’ll buy the software. No cost to me. Which one should I choose? Robohelp or Doc-to-Help Doc-to-Help was the first help authoring tool (HAT) I used in my technical writing […]

Why use Master Templates in Adobe FrameMaker?

Master templates let you control the format and positioning of every component in your FrameMaker documents.
In plain English this means that if you setup a footer as Arial, size 10, and then apply it to the main document, all footers will appear in this font and this size. Sounds good!

3 Tricks to Sharpen Your Screenshots

Diagrams, charts, and images all serve to enhance academic, business and technical documents. Without them the reader’s attention would flag and their interest wane.

How much can I make as a Tech Writer?

The median expected salary for a typical Technical Writing Supervisor 1 in the United States is $57,580. The Salary Wizard at salary.com has some terrific interactive tools for finding the base salaries, average salaries, and top paying roles in this field. They also offer the “Basic Salary Report based on broad national data, reported exclusively […]