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: Question of clarity From:Diane Giangrossi <dgiangrossi -at- BAKERHILL -dot- COM> Date:Mon, 21 Jun 1999 10:56:14 -0500
I'd do it like this -- one step with two sentences:
From the Plant Menu, select (13) for Work with Whatever. Then press Enter.
> -----Original Message-----
> From: Melissa Morgan [SMTP:mmorgan -at- INTREPID -dot- CDG-HARGRAY -dot- COM]
> Sent: Monday, 21 June, 1999 10:52 AM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Question of clarity
>
> I am trying to figure out what's the best
> way to present a complex step (not that
> it's difficult, but I want the instruction to
> read clearly). Some might argue that this
> should be broken into two steps, but
> I need to try and keep it in one step.
>
> Here's the sentence:
>
> From the Plant Menu, select (13) for Work
> with Whatever, and press Enter.
>
> A co-worker suggested that I remove the
> second comma. I explained that I put it
> there to cue the user...to clearly separate
> the sub-actions that make up the step.
>
> Does anyone have some ideas on the
> readability one way or the other? TIA
>
> ^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*
>
> Melissa Morgan
> mmorgan -at- intrepid -dot- cdg-hargray -dot- com
>
> ^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*
>
>
> From ??? -at- ??? Sun Jan 00 00:00:00 0000=
> =
>
