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: Sentence structure From:Matt Ion <mion -at- DIRECT -dot- CA> Date:Wed, 21 Jun 1995 13:55:58 PDT
On Wed, 21 Jun 1995 12:43:01 EDT you wrote:
> When you are giving an instruction in your documentation, do you first
> give the instruction, then identify the need or condition, or do you
> identify the need or condition first and follow it with the instruction?
It would depend on the situation, and to some degree the rest of the wording.
> A. To drive a car, first go to the department of transportation and apply
> for a driver's license.
This indicates that simply applying for a driver's license is all that's
required to drive a car... it says nothing of actually obtaining the license
or even learning how to drive. Those could be subsequent steps, of course,
but that isn't made clear.
> B. Go to the department of transportation and apply for a driver's
> license before driving a car.
This also suggests that simply applying for a license is enough preparation
for driving a car, but it is a lot clearer in that it doesn't imply that a
license will actually help one be ABLE to drive.
Technically, a license isn't a necessary prerequisite to driving... only to
driving on public roads. But that's nit-picking. :-)
> C. To access the reports database, exit the personnel screen and return
> to the main menu.
Good, but not enough. The simple addition of "then select the Reports option
from the Database menu" or the appropriate equivalent would complete it.
> D. Exit the personnel screen and return to the main menu before accessing
> the reports database.
Okay, but it seems to say only that this is the suggested course of action,
not that the "reports database" option is available from the main menu.
---------------------------------------------------------------------------
Opinions expressed / ROCK-IT SCIENCE Mobile Audio and Security
do not necessarily /| ...the 1040 MIDI & Music BBS Technical Services
reflect those of any [ SOUNDMAN Internet mion -at- direct -dot- ca Fido 1:153/7106
marginally sane human \| WWW http://www.musicwest.com/1040bbs/
being anywhere. \ FAX: (604)253-8312 DATA: (604)732-4446
---------------------------------------------------------------------------
