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: Do we need to document all UI elements? From:"Larry Usselman" <elgrans -at- gmail -dot- com> To:klhra -at- yahoo -dot- com Date:Thu, 26 Jun 2008 09:24:32 -0400
In an example like this, I'm reluctant to assume that the user knows exactly
what the "Send" button does. In some cases, it may send the e-mail
immediately...or it may activate the spell checker and require further
action by the user if errors are found. As much as I dislike it, sometimes
you have to hold your nose and write to the lowest common denominator. My
general rule has been to explain every UI element that the user must (or
may) use, no matter how obvious it seems.
On Thu, Jun 26, 2008 at 9:01 AM, Keith Hood <klhra -at- yahoo -dot- com> wrote:
> Some other controls, I think do not need to be documented if their nature
> and use are unmistakably obvious. For example, a "Send" button on an email
> interface - I think that's obvious enough that the average user can figure
> it out with no real problem. Of course, you do still have to consider the
> nature of the anticipated user. There are some elements that perhaps are not
> that obvious to someone who's not quite as experienced or as intelligent as
> you are.
>
> > On 6/25/08, mallikarjuna prasad
> > <mallikarjuna999 -at- yahoo -dot- co -dot- in> wrote:
> > >
> > > Hi,
> > >
> > > Do we need to document all UI elements?
> > >
> > > Cheers
> > >
>
>
--
Larry Usselman
Harrisburg, Dauphin Co., Pennsylvania
My Photos: http://www.pbase.com/snargle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-