TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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-
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-
