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.
Subject:Re: How do I document vaporware? From:Suzette Leeming <suzette -dot- leeming -at- gmail -dot- com> To:Sarah Stegall <sstegall -at- bivio -dot- net> Date:Tue, 27 Jan 2009 21:54:09 -0500
When I have topics on a menu that don't have functionality, I just say
"Currently underdevelopment", if I think it will be done in the next year,
"For ABC use only", if it may be something a client will never use (we tend
to dial into client systems and run special utilities in some situations, or
"Not Currently Available" if I don't when it will be developed.
? Please consider the environment before printing this e-mail
Need affordable web hosting? I recommend 1 & 1 - that's where I'm hosted! http://www.1and1.com/?k_id=6815038
Bill Cosby - "A word to the wise ain't necessary - it's the stupid ones
that need the advice."
On Tue, Jan 27, 2009 at 6:46 PM, Sarah Stegall <sstegall -at- bivio -dot- net> wrote:
> Having spent half a week taking all references to a certain feature OUT
> of our software documentation, I am now informed that these references
> are "placeholders" for future development. This means that when our
> users (other software developers) browse through the command line
> interface or the help menu, they are going to find undocumented commands
> (that don't currently do anything anyway).
> There's no telling when these "features" are actually going to be
> implemented (software design plan? We don't need no stinking plan...).
> What would be the best way to mention these in user documentation? I am
> afraid our users will be very confused when they happen across
> undocumented commands. Has anyone else had to deal with this? Thanks for
> any feedback.
> Sarah Stegall
> ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
> solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
> HTML and publish to the Web, Help systems or printed manuals.
> Help & Manual 5: The complete help authoring tool for individual
> authors and teams. Professional power, intuitive interface. Write
> once, publish to 8 formats. Multi-user authoring and version control!
> You are currently subscribed to TECHWR-L as suzette -dot- leeming -at- gmail -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
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-