Re: Doc Design and Convention - to address Gene's take on

Subject: Re: Doc Design and Convention - to address Gene's take on
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 9 Nov 2009 09:24:56 +0800 (WST)

Janice Gelb wrote:
> However, the engineers in question figured
> "Oh, this won't take too much time and I'm in there anyway"
> In one case, the engineers added an option with an
> icon to a main GUI menu because they thought it would
> be more helpful to users to get directly to a feature
> rather than going through a submenu. Even though we
> were at beta. And numerous screen shots that included
> the main menu had already been taken.

It's pretty common that engineers don't have a good idea of the consequences for documentation of a software change. At one extreme, major software changes relating to a bug fix or performance improvement can have no impact on the docs--they're just making the product work the way the manual said it was supposed to work. In the same way, apparently trivial last-minute UI changes can be a major pain for the TW.


Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems.

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:

Previous by Author: OT: Periodic table of typefaces
Next by Author: Re: Code Annotation of the Week
Previous by Thread: Re: Doc Design and Convention - to address Gene's take on
Next by Thread: OmniPage vs. FineReader

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

Sponsored Ads