Re: Step One. Done.

Subject: Re: Step One. Done.
From: Nancy Allison <maker -at- verizon -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 23 Jun 2010 15:08:42 -0500 (CDT)


I would rewrite each one and try to follow this pattern:

To open the TargetApp window, click Start>MenuOne>SubMenu.

Since there is no further step, the only possible goal of the procedure is to open the TargetApp window. Thus, I would state the goal first and then give the steps.

Depending on the surrounding format, I might possibly make it a bullet. I've sometimes had editors tell me to do that for one-step procedures. I suppose it's so that the bullet gives a visual clue that, yes, this is a procedure just like the numbered ones. (If there was no bullet, people might glance at it and assume there is no step to be followed, just explanatory text.)

This all assumes that the document is otherwise organized appropriately and the one-step procedures aren't part of a larger problem of weird thinking . . .

On Jun 23, 2010, Sarah Stegall <sstegall -at- bivio -dot- net> wrote:

I'm editing a user guide written by a subcontractor who is (clearly) not
a technical writer. I am consistently finding "procedures" which consist
of only one step, such as:



1. Click Start>MenuOne>SubMenu to open the TargetApp window.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days.
http://www.doctohelp.com/


---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Previous by Author: Re: Step One. Done.
Next by Author: Re: Nobody reviewed the manuals
Previous by Thread: Re: Step One. Done.
Next by Thread: Index entries in online help


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads