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 agree that metrics such as sentence length, syllables, paragraph
length, etc are important criteria. And so is good grammar. However,
documentation can excel in these areas and still be almost
I know. I am currently working a contract job at a high-tech company.
One of my primary inputs is existing documentation that is grammatically
correct and which meets any readability metric, but Albert Enstien could
not figure out. (It also has very nice page layout). I really get the
feeling that the authors did not know what the product did.
THE keys to readability are for the writer to know the end user and to
know the product.
I agree with the individual said to give the documentation to some 10th
graders and ask for their opinion. There is no other way of truely