RE: Undocumenting documented features

Subject: RE: Undocumenting documented features
From: "Jane Carnall" <jane -dot- carnall -at- digitalbridges -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 9 Aug 2001 13:56:10 +0100

Gild Spitz says:
> 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.

Can you create a one-page (single topic) reference section, to which all the
dialogs and menu picks to do with this obsolete functionality lead, where
you can simply say "This functionality is now replaced by - " Tool XXXX.

That way, if anyone looks it up, they'll find *something* - and that
something will point them where you want them to go.

Jane Carnall
Technical Writer, Digital Bridges, Scotland
Unless stated otherwise, these opinions are mine, and mine alone.


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

*** 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.


References:
Undocumenting documented features: From: Gilda Spitz

Previous by Author: RE: An honest usability engineer
Next by Author: RE: New TECHWR-L Poll Question
Previous by Thread: Undocumenting documented features
Next by Thread: Re: Undocumenting documented features


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


Sponsored Ads