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.
First, my apologies for continuing several good discussions about this matter off-list and forgetting to Cc Techwr-L. Unfortunately, none of the suggestions has solved my immediate problem, but thanks go to several people for giving it a try: Geoff Hart (we'll have to agree to disagree on the usefulness of Flesch-Kincaid, eh? ;->), Dick Margulis, Dave Neeley, Kat Nagel, et al.
As I mentioned to Dick Margulis, this manual is for home-use medical equipment, hence the 7th grade reading level and the highly regulated nature of the requirement. If anyone is not familiar with FDA req's, it's not unlike ISO: our product spec states that we will provide X with this product. Then we do it, and back that up with the proper testing and documentation. That's easy enough, relatively speaking, it's breaking a college-level operation manual down so a layperson can understand it that's proving to be a challenge.
Based on trying various methods and suggestions from the list, I've reached a few conclusions. First, and most disappointing, there doesn't seem to be any easy way to do this! It's grunt writing, pure and simple. On the other hand, the re-write is such a challenge that I kind of hope some of this project comes my way. Second: we need to work with a clinical SME, emphasizing information in the manual that the homecare user must understand, removing information they won't need (calculation of fractional inspired oxygen comes to mind).
Next: pictures. Absolutely. There is simply no way to remove the correct terminology from the manual. If it's called an inspiratory bacteria filter, the user must learn that term. Simple line art and exploded diagrams will make a big difference. A glossary is also a must.
A couple of people suggested using interns, recent high school grads, etc. to look over the manual and highlight everything they don't understand. Excellent suggestion--fast, cheap, low tech. We might even have a few "typical users" around the company that could do a first-pass review (typical, to my mind would include someone with no medical or computer training.) An outside editor would be great, but unlikely due to time constraints.
Back to work, me!
Linda
========================================================================
CONFIDENTIALITY NOTICE
----------------------
This message, together with any attachments, may be legally privileged
and is confidential information intended only for the use of the
individual or entity to which it is addressed. It is exempt from
disclosure under applicable law including court orders. If you are not
the intended recipient, you are hereby notified that any use,
dissemination, distribution or copy of this message, or any attachment,
is strictly prohibited. If you have received this message in error,
please notify the original sender and delete this message, along with
any attachments, from your computer.
