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:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 28 Jan 2009 07:10:35 -0800
And then they'll decide not to buy the software now and
wait for the "future development" features to be released .
That's what I would do, and yes, I obtain documents or
evaluation versions for software and read them before I
buy, because my track record on software is that I end
up not buying about 90% of products I evaluate.
I would format the references to unimplemented features
as hidden text. Nobody outside of your development
team should have any idea that anyone in the team has
even thought of them until they're ready for at least a
Does your company not have a Marketing department...?
> 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.
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-