RE: Documenting the user interface

Subject: RE: Documenting the user interface
From: "Dubin, David" <David -dot- Dubin -at- sage -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Jan 2007 16:17:42 -0000

As Melissa Nelson and others have pointed out, "this is a 'know your
audience' type thing." However I would carry that one step further -it
is also a "know your purpose" type thing.

Technical documentation does not have to be a dry presentation of what
every field, function, or menu item does unless that is the purpose of
that documentation. Just as one writes for different audiences, one
should also write for different purposes. Is the document meant to be
informative or instructional? (Yes, there is a difference.) If it is
instructional, how can one document a function or feature without tying
it back to the specific process for which that feature, function or
button was designed? If that is the case, why would you document
buttons, icons, etc. that have nothing to do with that individual
process? You wouldn't. Therefore, I would suggest that both audience and
purpose be the guide, not just audience alone.

David B. Dubin
Senior Curriculum Developer
Sage Software
727-579-1111 x 3356
david -dot- dubin -at- sage -dot- com
Your business in mind.


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!

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.

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

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 for more resources and info.

RE: Documenting the user interface: From: Melissa Nelson

Previous by Author: Readability Question
Next by Author: RE: Translations
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