Re: Wordiness and Complete Sentences

Subject: Re: Wordiness and Complete Sentences
From: Sarah Perrault <sarahp -at- KEYSAFE -dot- COM>
Date: Fri, 21 Jun 1996 08:08:00 PDT

>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?

Agree.

When writing for admins/programmers, I'd use the style they prefer - after
all, we try to tailor the docs to the audience, right?

When I write for a non-technical audience I often do both -- "bury" the
information in complete sentences, but also provide lists, tables,
appendices etc that give "unburied" access to the same stuff. In one manual,
I presented the same information four ways. This was an extreme example, but
it worked -- once in paragraph/explanation format, once in a table, and
twice in flow charts. (I would have done only one flow chart but my division
head made a chart *he* liked so I put it in too.)

Sarah
------------------------
Sarah Perrault
Technical Writer
Supra Products, Inc.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


Previous by Author: Re: From Tech Writer to ?
Next by Author: New Technical Writer
Previous by Thread: Re: Wordiness and Complete Sentences
Next by Thread: Re: Wordiness and Complete Sentences


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

Sponsored Ads


Sponsored Ads