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: Documenting the user interface From:"Combs, Richard" <richard -dot- combs -at- Polycom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 10 Jan 2007 17:28:54 -0700
[I'm checking mail remotely, so forgive formatting weirdness; I have no control.]
Janice Gelb wrote:
> Not sure I agree that "users will wonder" why things exist in
the user interface. I think most users buy a product to
accomplish some task and with very few exceptions, their
interest in the interface is solely related to how to use
it to accomplish that task. That's why I agree that you
don't need to describe every button, tab, field, etc. They
should only be described in the tasks in which they are
used to accomplish something.
I'll go further -- in some cases, you don't even have to exhaustively describe everything they use to accomplish something. I'd argue that if "users will wonder," that's not necessarily a bad thing. It can be a very good thing to encourage exploration and learning.
Richard
------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
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-