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.
Bill Fetzner wrote, ". . . is there any evidence of that level of disregard
among professional technical writers?" I would say yes, with the caveat that
some of these technical writers may be using English as a second language.
For example, how many of you have looked at the instructions that accompany
a new cell phone or digital camera? If you have, have you noticed that some
functionality is poorly documented, some not documented at all, and other
functionality documented with WHAT to do and no explanation of WHY you
should do it that way? The same thing is true of software. The Help doesn't
and the documentation is feature oriented, rather than process oriented. In
other words, it tells you what a button or icon does, but does not explain
the process flow or provide process-based knowledge on solving the problem
that the software was designed to resolve or how the software is to be used
to complete the manual function that it was designed to replace.
David B. Dubin, PHR
Senior Curriculum Developer
Sage Software
727-579-1111 x 3356
david -dot- dubin -at- sage -dot- com
Your business in mind.
-----Original Message-----
From: techwr-l-bounces+david -dot- dubin=sage -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+david -dot- dubin=sage -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Fetzner, Bill
Sent: Thursday, May 25, 2006 2:35 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Tech writing saves journalism
David Durbin writes: <<Anyway, with abject apathy comes little need for the
media to be totally truthful, objective, or comprehensive in reporting
news.>>
To bring this back to the main focus of this list, technical writing, could
we make such a statement about technical writers today? Let's suppose that
there's a parallel between "the media" and the body of profession writers,
like those on this list, who are in the forefront of their respective
fields. If it's true that many professional journalists have lost their
truthful, balanced way, is there any evidence of that level of disregard
among professional technical writers? Is it fair to blame readers for poor
writing or for lowered standards of professional conduct? Should technical
writing be taught in J-schools to raise the standards and practices?
~ Bill
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l