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: How would you revise? From:Ned Bedinger <doc -at- edwordsmith -dot- com> To:Ben <baj357 -at- gmail -dot- com> Date:Thu, 19 Jul 2007 12:25:58 -0700
Ben wrote:
> Without any further context, how would you revise the following?
If I may assume that the author usually writes instructions this way,
and that the user is qualified to know what these instructions are about...
> When a loop is running, once the first loop is completed, the lines in the
> loop are not editable anymore.
I think the original writer was deliberately ordering ALL of the
qualifications before the instruction.
I think this is a good practice, because it prevents the user from
reading and executing an instruction before finishing reading all the
conditions that apply.
This inhibiting effect works best when the writer applies the rule of
order consistently.
My revision: "When a loop is running, you
> cannot edit the lines in the loop after the first loop is completed."
You've undone the author's effort at consistency.
>
> Or revise this sentence: "For submitted sequences, all lines are editable."
> My revision: "You can edit all lines for submitted sequences."
The author does indeed appear to practice safe ordering of instructions
and conditions.
> Your thoughts?
I think the instructions are best left alone, apart from the felicitous
insights that other responses have provided you.
Hope this helps.
Ned Bedinger
doc -at- edwordsmith -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-