Examining documentation and help systems since 2002
Contents
Special Reports
Subscription Feed
Gordon R. Meyer
Copyright 2002-2012
Favorite Sites
Grammar Girl's Quick and Dirty Tips for Better Writing
Avoiding the endless march
Gary Conroy covers an important subject in "Stop it with those 50-Step Procedures." Some folks think that writing procedures is easy -- just jot down all the steps and you're done. But that results in a transcript, not usable documentation. You cross the line of usefulness far before you hit 50 steps, but Conroy's point is well taken. His suggestions will get you started in correcting the problem.
I'll add that the same guidelines apply to all procedures, not just the long ones. If you're writing 7 steps, perhaps it is really 3 steps and you've fallen into the same trap on a smaller scale. Looking critically at all of your own work, not just the glaring sore spots, can make a big difference.
Posted: February 14, 2003 link to this item, respond to this item