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.
> So in the doc I want to say that âYou can <access the function screen>
> from two starting points in the menu:â, then give the bullet list of
> the two menu paths, and then I want to explain that they bring you to
> the same screen.
>
> So for that final sentence, which of the following is best, and, more
> importantly, why?
>
> * Both menu selections bring you to the <function> screen.
> * Either menu selection brings you to the <function> screen.
You start by telling them to access the <function> screen in one of two ways and end by telling them those are the two ways to access the <function> screen. Too many words. Too much repetition and detail. That's how you end up with a thousand-page manual that nobody ever reads.
> Or, maybe I avoid it altogether and just say, âWhen you choose the
> <function> from the Dashboard menu, the <function> screen appears.â
Much better.
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
