RE: Documenting missing features

Subject: RE: Documenting missing features
From: Paul Hanson <phanson -at- Quintrex -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 31 Mar 2010 09:52:30 -0500

Couldn't click Send fast enough.

I totally agree with Gene, especially about not including any promises that its function will change in a future release.

Paul

-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Gene Kim-Eng
Sent: Wednesday, March 31, 2010 9:44 AM
To: Viv Crawford; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Documenting missing features

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: http://www.doctohelp.com

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:
http://www.ModernAnalyst.com

---
You are currently subscribed to TECHWR-L as PHanson -at- quintrex -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/phanson%40quintrex.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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: http://www.doctohelp.com

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:
http://www.ModernAnalyst.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Documenting missing features: From: Viv Crawford
Re: Documenting missing features: From: Gene Kim-Eng

Previous by Author: RE: Which would you prefer and why? (Help Tool)
Next by Author: RE: Profanity in the workplace (Dan Goldstein)
Previous by Thread: Re: Documenting missing features
Next by Thread: Re: [HATT] Adobe Presenter


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

Sponsored Ads


Sponsored Ads