UI description standards

Subject: UI description standards
From: p -dot- vuncanon -at- att -dot- net
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 19 Apr 2010 19:07:29 +0000

Currently going through the debate of eliminating screen shots vs. keeping screen shots as part of a technical publications standard. There's some strong opinions on both sides of the issue.

However, my question is not specifically about the eliminate vs. keep screen shots issue.

Should the decision be to eliminate screen shots from the documentation, I'd like to ask folks if they know of (or can point me to) a set of standards that describe how one should document UI elements in the most foolproof and readily understandable fashion possible.


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com

- Use this space to communicate with TECHWR-L readers -
- Contact admin -at- techwr-l -dot- com for more information -

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

Please move off-topic discussions to the Chat list, at:


Previous by Author: Beta documentation quality
Next by Author: Re: Equipment illustrations; was: Re: How do hiring companies view TW resumes?
Previous by Thread: Re: Are there any active support forums for MS HTML Help?
Next by Thread: Re: UI description standards

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

Sponsored Ads