RE: Documenting the user interface

Subject: RE: Documenting the user interface
From: "Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>
To: <Gordon -dot- McLean -at- GrahamTechnology -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Jan 2007 09:41:39 -0500

I've undergone the same conversion Gordon mentions. My aim these days
is to document the important stuff so that it doesn't get lost in the
weeds. Yes, I know you can use the main doc for important thing and the
reference doc to cover everything, but I question the use of having
pages and pages full of things like:

"Exit - click to return to the previous task".

Might as well leave that for a tooltip or the equivalent. Yes, it would
help if I could specify what the previous task was. But we know only at
run time, which is too late for printed or PDF documentation.

Jessica Weissman



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

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: RE: undeploy
Next by Author: RE: Help in Evaluating HATs
Previous by Thread: RE: Documenting the user interface
Next by Thread: RE: Documenting the user interface


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


Sponsored Ads