Re: Should I document this feature?

Subject: Re: Should I document this feature?
From: Mike Stockman <mstockman -at- gmail -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 6 Aug 2010 10:35:25 -0400

On Fri, Aug 6, 2010 at 10:22 AM, Joe Weinmunson <litlfrog -at- gmail -dot- com> wrote:

> There are three menu functions that involve the
> license: updating, reading license information, and copying a license
> from one file to another. However, I can't think of any situation
> where the end user can or should be using those menu functions if
> they're not on the phone with tech support anyway. Should I leave
> those commands out of the documentation completely? Explain what each
> one does? Or take some kind of middle road? Thanks.

Document them all, but include some explanation similar to "This command is
not required for normal product use. However, a technical support
representative may ask you to [whatever] in the course of product
troubleshooting. Unless you're asked to [whatever], you can ignore this

Otherwise, the user is left wondering whether you forgot to mention
something important, and will break the licensing by fiddling around to see
what it does. Which may happen anyway, but, you know, we can only put up a
sign saying "Bridge Out," we can't help them apply the brakes.

Hope this helps,
Mike Stockman
ICQ #: 19165236 AIM: MStockman
MSN Messenger: mstockman -at- hotmail -dot- com
Yahoo: me_stockman GMail Talk: mstockman -at- gmail -dot- com

Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days.

LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at:

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 I document this feature?: From: Joe Weinmunson

Previous by Author: RE: chapter TOCs in Word 2007
Next by Author: Re: What's THAT for?
Previous by Thread: Should I document this feature?
Next by Thread: Re: Should I document this feature?

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

Sponsored Ads