Re: Should software documenters learn to read code?

Subject: Re: Should software documenters learn to read code?
From: Peter Neilson <neilson -at- windstream -dot- net>
To: "Downing, David" <DavidDowning -at- users -dot- com>
Date: Thu, 12 Feb 2009 10:31:46 -0500

Downing, David wrote:
> ...
> But there is a danger. ...
> technical writer who starts reading code might start thinking this way
> as well.

Not in my experience. The TW is always looking at the end result, and
(in my experience) reads to code to find features that were supposed to
be in there, but don't quite work.

"Oh yes," says the software designer, when confronted with the "-g" flag
that you discovered (by reading code) he had changed to "-w", "I did
change that. In fact, I think I must have changed it three months ago. I
just forgot to mention it to you. And I guess I didn't mention it in the
--help, either. I wonder if I should change it back?" He's the same one
who complained at yesterday's team meeting that the reason the TW
couldn't get the "-g" option to work was undoubtedly laziness or
stupidity, and that he didn't have time to deal with either of them.

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.

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!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

Should software documenters learn to read code?: From: Downing, David

Previous by Author: Re: editing text in Flash movie
Next by Author: Re: Nested bullets - how many levels deep do you go?
Previous by Thread: Re: Should software documenters learn to read code?
Next by Thread: Re: Should software documenters learn to read code?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads