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.
One of the constant gripes I've heard is that technical writing is "not
like people talk", and it seems this pain letter falls in that vein.
The problem though is that "plain English" is full of inexactness. The best
technical writing (imho) ensures that there is no inexactness. So yes, the
writing may not read like how humans speak, but it should direct the users
how to perform their tasks.
And, as Gene points out, it should also cover all the details, because
documentation is official company communications to the user. If the user
gets hurt or injured enacting the instructions, then it's the company's
fault.
-David
On Tue, Apr 22, 2014 at 1:09 PM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
> Yes, products sold to regulated markets and industry segments (aviation,
> medical, manufacturing, etc.) frequently have requirements to deliver
> documentation. The poundage is the result of the levels of detail
> required, and where safety and liability are critical, the regulators
> actually READ the docs and will come back at you if you don't cover all the
> requirements, stopping certifications, deliveries and payments dead in
> their tracks until their issues have been addressed to their satisfaction.
> This is something that technical writers who mostly deliver software-based
> products seldom encounter, I think, unless their employers are selling to
> government agencies.
>
> Gene Kim-Eng
>
>
> On Tue, Apr 22, 2014 at 10:52 AM, Peter Neilson <neilson -at- windstream -dot- net
> >wrote:
>
> >
> >
> > Maybe I'm wrong. Maybe there are shops out there where people have pains
> > about writing. "Oh, if only we could discover someone who could explain
> our
> > stupid product better. I'm tearing out my hair." Occasionally there is
> > pressure from requirements or from Federal regulations. "To be delivered
> > with Operations Manual no less than 4.2 pounds (1.90509 kg) in weight."
> >
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp
> enhancements, and more. Read all about it.
>
> Learn more: http://bit.ly/NNcWqS
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as freetaco -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.
