Re: How do I document vaporware?

Subject: Re: How do I document vaporware?
From: Susan W Gallagher <susanwg -at- gmail -dot- com>
To: Sarah Stegall <sstegall -at- bivio -dot- net>
Date: Tue, 27 Jan 2009 19:03:55 -0800

This is common in programmer docs. A simple "Not yet implemented" will
suffice. Your software dev audience will nod their heads and move on.
HTH
-Sue Gallagher


On 1/27/09, 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.
> 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 susanwg -at- gmail -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/susanwg%40gmail.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
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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


Follow-Ups:

References:
How do I document vaporware?: From: Sarah Stegall

Previous by Author: Question about Creating Forms with Robohelp
Next by Author: RE: Camtasia vs Captivate vs other? For quiz
Previous by Thread: Re: How do I document vaporware?
Next by Thread: RE: How do I document vaporware?


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


Sponsored Ads