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.
" A skilled technical writer puts on paper what they know the user
should know and perhaps more importantly, doesn't include what the
user doesn't need to know. Because the capable writer knows that there
is something that is only of interest to development doesn't mean that
the writer will include it."
Exactly. My first thought in response to this thread was "...as long
as you remember the user."
-----Original Message-----
From: techwr-l-bounces+vincent -dot- latella=saic -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+vincent -dot- latella=saic -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of John Posada
Sent: Thursday, February 12, 2009 10:46 AM
To: Downing, David
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Should software documenters learn to read code?
> Agreed, that's a potential benefit. I'm just thinking there's a
potential danger to go with that benefit.
You mean "Luke..beware of the Darkside."?
Maybe if the tech writer isn't skilled. Those types of writers don't
know the difference between what they should explain and what they
shouldn't, so they try to put on paper everything they know and
everything the developer tells them.
A skilled technical writer puts on paper what they know the user
should know and perhaps more importantly, doesn't include what the
user doesn't need to know. Because the capable writer knows that there
is something that is only of interest to development doesn't mean that
the writer will include it.
That's why companies who hire writers only on rate end up getting the
lowest quality deliverable. What they are getting instead is a
transcription machine that takes lunch and misspells words.
--
John Posada
Senior Technical Writer
NYMetro STC President
Looking for the next gig.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as VINCENT -dot- LATELLA -at- saic -dot- com -dot-
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
