Re: Documenting missing features

Subject: Re: Documenting missing features
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Viv Crawford" <viv_crawford -at- hotmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 31 Mar 2010 07:43:32 -0700

I would document the module as it functions now, including the fact that data
cannot be deleted from the module once it has been added. I would leave out any
promises that its function will change in a future release. Then talk to
whoever owns the development of the product, let them know the documentation
exists and leave the decision as to whether it should be provided and where
(user manual, appendix to same, readme file, etc.) to them.

Gene Kim-Eng

----- Original Message -----
From: "Viv Crawford" <viv_crawford -at- hotmail -dot- com>
> We have a first release of a new piece of software due out in a couple of
> weeks.
> There is a peripheral module that was added on at the last minute that is what
> you might call incomplete in that I can add stuff in this module but I cannot
> yet remove it. I'll be able to remove it in a future release, most likely the
> next one.
> My question is about whether I should document that at the minute you cannot
> remove these things.


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free 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:


Documenting missing features: From: Viv Crawford

Previous by Author: Re: Vendor tricks (was Which would you prefer and why? (Help Tool))
Next by Author: RE: RE: OFT: But close to Re: Another warning label for the recordbooks...
Previous by Thread: Re: Documenting missing features
Next by Thread: RE: Documenting missing features

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

Sponsored Ads