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:Craig Haiss <craighaiss -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 11 May 2009 07:22:26 -0700 (PDT)
Perhaps the clutter of UI information can be reduced by grouping all such content into a single chapter of the documentation. If the chapter is clearly introduced in the opening paragraph and table of contents, users can simply skip it if they aren't interested.
In help, clutter isn't really an issue. Users only see what they click on. One clearly-worded link in the TOC would give UI information a high profile for people who seek it, while at the same time avoiding clutter.
--- On Sat, 5/9/09, Robert Lauriston <robert -at- lauriston -dot- com> wrote:
> From: Robert Lauriston <robert -at- lauriston -dot- com>
> Subject: Re: A reminder: visual and other indexes
> To: "TECHWR-L Writing" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Date: Saturday, May 9, 2009, 1:00 PM
> 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.
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-
