TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I do this daily, and when I write a procedure, I see if a page of words,
jargon, whatever can be replaced with a simple illustration. I also take my
documents out there on the production floor and follow them step-by-step.
This uncovers flaws toot sweet. Often what can happen is I do things
automatically out of habit, and tend not to include them in the documents.
Here is a great test I give other people who want to write Training
Materials. I ask them to write out the procedure for tying a pair of shoes.
Try it, it is much harder than you think. Then I give it to another person
and have them follow it precisely. It is a great test.
