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.
> If for example, the standard formatting calls for
> right-size numbered steps (written in the active
> voice), if I have "holes" in my understanding of the
> subject matter, I can try and hide such by switching
> to unnumbered (read: often non sequential), large
> paragraphs written in puffed up, vague,
> non-active-voice language.
I can't speak for where you worked, but a style change that drastic would
send up an immediate red flag here. It would draw attention to itself,
rather than mask any problems. I can't imagine a writer could get away with
that. Sooner or later, somebody is going to read it.
> Rationale: If they can't establish the flow of it
> and/or get specific with it, then maybe they will not
> be able t see the holes in it. Happened all the time
> at the DOD agency which I contracted at. (Often times
> such text was prefixed with a statement like "The
> procedure to do X is simple.")
As a manager, I can teach a writer how to get information from SMEs and
other resources, to fill in the documentation gaps. But I would be much more
disturbed by deliberate attempts to deceive me, and ultimately, my
customers. Tony, do you know for sure that this was purposely done? Could
the issue be that they were not properly trained or were not competent
enough to do the job right?
This e-mail, and any attachments are strictly confidential and intended for the addressee(s) only. The content may also contain legal, professional or other privileged information. If you are not the intended recipient, please notify the sender immediately, by return of email, and then delete the e-mail and any attachments. You should not disclose, copy or take any action in reliance on this transmission.
Please ensure you have adequate virus protection before you open or detach any documents from this transmission.
This email has been scanned by the MessageLabs Email Security System.
For more information please visit http://www.messagelabs.com/email
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l