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.
You mention:
>>>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.Â<<<
When you are starting with saying that users can access the screen from two points, why would you want to repeat the same info at the end? You might begin your paragraph with:Â
You can access the <function> screen from either of the following menu commands: <a> and <b>.
Iâm describing a situation where there are two different menu items that result in the same screen being displayed.
(No need to comment on why this isnât a good idea â this is a temporary state in the software thatâs intended to make some big picture changes easier for current customers to deal with, and on the resulting screen this is clearly explained.)
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.
Or, maybe I avoid it altogether and just say, âWhen you choose the <function> from the Dashboard menu, the <function> screen appears.â
Thoughts?
-Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
