Documentation as a Backup for UI Deficiencies?

Here is a view that has some weight to it, on the basis of my personal experience as a Fortune 500 technical communicator: “[Software] Documentation is rapidly becoming a backup for deficiencies in the user interface and user training rather than a complete solution in itself.” And here is an intelligent blog post that discusses…

Read More

The Importance of Writing Perfect Checklists

Ask yourself: would you be willing to fly in an airplane flown by a pilot who relies on his or her “memory and track record” rather than a detailed and time-tested checklist? I wouldn’t. The deeper question is: if checklists are perfect and indispensable for flying airplanes safely and reliably, then why don’t we use…

Read More

How to Become a Technical Writer

(A personal account published at Tom Johnson’s excellent blog) by Sarah Pruitt Deciding to become a technical writer was easy. But finding the experience and the time has proven unforgiving. My job is not based on writing; in fact, writing is rarely needed. Between working full-time at a bank doing account maintenance (which is equivalent…

Read More

"Me" or "I"? A Simple Method to Use the Correct Pronoun

© 2010 Ugur Akinci Sometimes people are confused whether to use “me” or “I” in a sentence. For example, which is correct: “Me and Jimmy watched a movie”… or “I and Jimmy watched a movie”? First off, it always sounds better if you cite the other person FIRST, as in “Jimmy and me…” or “Jimmy…

Read More

Scheduling and Keeping Up with Your Goals & Clients

You’ve made a New Year’s resolution… You want to write that book… Get that diploma or certificate… Exercise 3 times a week… or whatever it may be. But there’s a slight “problem”… How are you going to keep track of all those promises? Why, with scheduling software of course! Here are some suggestions: Google Calendar.…

Read More