TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: A reminder: visual and other indexes From:Robert Lauriston <robert -at- lauriston -dot- com> To:TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 9 May 2009 10:00:32 -0700
Yeah, it's very annoying when docs don't tell you how to navigate to
the command / dialog being discussed, but screenshots of menus just
clutter up the doc and waste the writer's time.
My negative attitude about that sort of thing was probably exacerbated
by having inherited so many docs that contained nothing but a useless
narrative of the UI.
> The second is that most documentation provides no way to look up
> things you can see on the screen. I've occasionally had problems with
> Adobe documentation, for example, because they'll write something like
> "to fram statically, use the framistat tool" without showing me what
> that tool looks like or where it's hidden.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-