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.
> >> The Golden Rules of Writing
> >> 1. Make it understandable.
> >> 2. Make it consistent, unless that interferes with Rule 1.
> >> 3. Make it grammatically correct, unless that interferes with Rule 1 or 2.
> >> 4. Make it technically correct, unless that interferes with Rule 1, 2, or
> >> 3.
How about this:
1. Make it understandable.
2. Make it technically correct. If that interferes with Rule 1, keep
3. Make it consistent, unless that interferes with Rule 1 or 2.
4. Make it grammatically correct, unless that interferes with Rule 1,
2, or 3.
Why? As someone already said, it's of no use if it's not
However, "technically correct" must come next, because it won't help if
it's consistent and grammatically correct if the information is false.
As someone else already pointed out, though, it doesn't have to be
technically *complete* -- you can leave out technically correct details
if they aren't useful to the reader (although I'm the type who prefers
to put it in an appendix because there's bound to be a few users who
want to know it and will call Tech Support screaming for the info.)
For 3 and 4, though, I'm torn about which is more important,
consistency or grammatical correctness.
Mary M. Moore (mmoore -at- banyan -dot- com)
Sr. Technical Writer
All opinions I express here are strictly my own and do not reflect
the opinions or policies of my employer.