RE: Documenting the User Interface

["Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>]

My rubric for user documentation is:

1.	Make sure you're very familiar with the UI/App.  Make a list of
its functions, etc.
2.	Screenshots.  Good screenshots.  The old adage "A picture is
worth a thousand words" rings true. I use Paint Shop to take the
screenshot and Visio to overlay captions, etc.  You can use XP's print
screen, but the resolution is not good.    
3.	Depending on the complexity, I tend to use short sentences or
bulleted lists to list procedures or descriptions.  (Information
Mapping, in other words.)
4.	Don't assume the user's level of expertise.  Know your audience!
5.	KISS-Keep It Short, Simple.  

Of course, I write more web-based documentation than printed
documentation.  

Hope that helps,

RGBrasel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.