Re: Documenting the user interface--unnecessary features?

Subject: Re: Documenting the user interface--unnecessary features?
From: Beth Agnew <beth -dot- agnew -at- senecac -dot- on -dot- ca>
Date: Thu, 11 Jan 2007 11:48:25 -0500

When we started doing task-based documentation rather than just documenting every feature, button, etc., the question usually came up "What if you document all the tasks and you still haven't covered every feature?". All you good techwriters know the answer to that, but the developers were shocked to learn that if every possible task has been documented and some UI items or features weren't mentioned, by golly then maybe they're redundant / unnecessary features! Those conversations were always a lot of fun -- for me, anyway. I'm with you, Gordon, I'd argue the case. If it's in the product, and it's something users need, it should be in the doc.

Gordon McLean wrote:

Well I guess in some instances it can be as much a culture decision as
anything. If you have a genuine need to document every single UI button,
widget and doo-dah, then do so.

However anywhere I've worked, I've been able to question WHY something was
in the product, so maybe that's a discussion to have with your manager.
Perhaps certain UI items have been left in rather then being removed because
it was easier for development? Who knows.

But, if your manager says it should be doc'd, then doc'd it'll be (I'd still
argue my case with him though.. but that's just me).


-----Original Message-----
techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr]On Behalf Of Kay Honaker
Sent: 11 January 2007 15:34
To: Peter Sturgeon; TECHWR-L
Subject: RE: Documenting the user interface--unnecessary features?

Quote from my manager: "If it's in the product, then it should be in doc. Is
how I generally see it."

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!

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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.


RE: Documenting the user interface--unnecessary features?: From: Gordon McLean

Previous by Author: Re: documenting games redux
Next by Author: Re: Tips on Getting Hired
Previous by Thread: RE: Documenting the user interface--unnecessary features?
Next by Thread: Re: Documenting the user interface--unnecessary features?

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

Sponsored Ads