Undocumenting documented features

Subject: Undocumenting documented features
From: "Gilda Spitz" <gspitz -at- longview -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 9 Aug 2001 08:47:17 -0400

We have a very large Reference Guide that describes all the commands and
functions in our software.

There's one area of the functionality that our customers don't use any
more (because they can do the same tasks, more easily and efficiently,
with another product from our company). The documentation for the
obsolete functionality takes about 100 pages of the Ref Guide, and lots
of HTML pages in the online help.

I've wanted to get rid of those pages for a long time, but only if the
functionality was stripped out of the software. After much pleading, I
finally got upper management to agree in principle - but it turns out to
be more trouble than it's worth, from a programming point of view.

So now they've asked me to just delete the pages in the documentation,
even though the functionality still exists, and still works. But this
means that certain dialogs and menu picks would still appear in the
software, with no explanation in the docs.

I feel very uncomfortable about undocumented features. I plan to get
some feedback from our users, but in the meantime....Has anyone out
there had a similar experience? What would you do?

Gilda Spitz
Manager, Documentation
Longview Solutions Inc.


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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: Robohelp (on the Developer's Side)
Next by Author: RE: Undocumenting documented features
Previous by Thread: RE: just when you think you heard it all
Next by Thread: RE: Undocumenting documented features


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


Sponsored Ads