Sample Guidelines for Writing Online Help

If you’re looking for guidelines to write your online help documentation, then use this checklist to get started.

21 Words That Make Technical Writers Look Dumb

We both know that a Microsoft Exchange Server doesn’t have feelings, hopes and desires. But when we write technical documents, these type of human feelings can creep in. You need to be careful when writing user guides, design documents, and specifications as these false words give the wrong impression and undermine the quality of your material.

MadCap Review

MadCap has released a product – MadCap Feedback – that is new to me and looks like it has a nice set of features especially if you want to close the loop between technical writers/technical communicators and end users. And who doesn’t want to do that!. Its Feedback Server has a Web 2.0 reporting tool that gives technical authors, information designers, and educational content developers insight into the end-user experience.

My Ten Favorite Technical Writing Tools

I’ll be honest. I love Microsoft Word! Adobe FrameMaker has it’s moment but, y’know, it’s can be so lame that it beggar’s belief. 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?

How to Setup a Technical Writing Department

This year I’ve helped two companies setup their Technical Documentation Departments. To be honest, they call them Technical Communications Department, but that’s another matter. One of the problems in getting the dept setup was communicating the value that the tech docs dept could offer other business units and also how it would save them money. In the end we got there but there was a lot of negotiating and arm-twisting along the way.

How Social Media Will Make You a Better Technical Writer

Gina Blednyh launched the Technical Communication 2.0 group in Facebook in 2009. It explores the interplay between Web 2.0 and technical communication. It’s a terrific place to exchange ideas about collaborative technologies and new approaches to delivering information. In this interview, I ask her how Technical Writers can use Social Media and the types of […]