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: Wordiness and Complete Sentences From:Kat Nagel/MasterWork <katnagel -at- EZNET -dot- NET> Date:Thu, 20 Jun 1996 15:46:38 -0400
John Russell wrote:
>I am leaning toward reworking a significant portion of the manual in
>favor of incomplete sentences where appropriate/useful/necessary.
>What would/do you do? Agree? Disagree? Thoughts? Comments?
Personally, I -like- bulleted lists, numbered lists, and task tables for
any type of instructional material (and I consider manuals to be
instructional materials). BUT there are certain chunks of manuals that
don't conveniently fit into such rigid, step-by-step structures. And
-any- formatting trick becomes very boring after a few hundred pages. Why
not use a combination approach like this one?
This is a description of the task and what it is used for xxxx
To get from point A to point B:
o step 1
o step 2
o step 3
o step 4
Procedure X is also useful for xxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxx (see Section YY).
@Kat _______________________________ katnagel -at- eznet -dot- net
Kat Nagel MasterWork Consulting Services, Rochester, NY
Technical writing / Document design / Information services
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net