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:Imperatives in procedures? From:Jeff Scattini <jeff -dot- scattini -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 21 Nov 2005 13:51:28 -0800
Hi all,
I'm currently writing a series of task-oriented documents for a
software application.
I learned that one should always put the user-imperative at the
beginning of each step:
1. Click Start on the toolbar.
2. Select the program you want and double click that program.
However, one of my product managers wants to bury the imperative in
surrounding text:
1. On the left-hand side of the toolbar, click the Start button.
2. You can from there, search for the program that you want and then
click that program to open it. The program window will then open.
I have searched the MS Manual of Style, (which is what we've used as a
starting point for our in-house style guide) and it states that you
can put the navigation before the imperative. Our in-house style guide
states to use the imperative first, but the in-house styles are less
than 6 months old and still fairly fluid.
I'm trying to get a sense if I'm picking a dumb battle or if people
have found that using the imperative is more or less usable for their
readers.
Thanks,
Jeff
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-