Re: introducing steps

Subject: Re: introducing steps
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 18 Oct 2011 00:31:25 -0400

On Mon, 17 Oct 2011 23:45:21 -0400, Janice "on target" Gelb <janice -dot- gelb -at- oracle -dot- com> wrote:

adding "follow these steps" seems like unnecessary verbiage.

Seen in a document once, on Mars or somewhere. Ask your teacher about it:

"This document consists of material that has been carefully researched by professional writers. Please read it carefully before using the product."

The writer of that stuff only dipped into the well. Here's what could have followed:
"The pages of this technical document are filled with paragraphs. As specified in Strunk and White Rule 13, each paragraph is constructed of sentences and each sentence is in turn constructed of words. These words have been chosen with great care in order to pass on to the reader the knowledge that is necessary to understand the usage of the equipment and computer programs described herein. Complete reading and full comprehension of this material, while not mandatory, is highly recommended."

If the writing is to contain information about the writing, you could suggest also that the teacher tell you how to write colophons. Here Janice Gelb was again on target, quoting Tom Weller in this reference:

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

introducing steps: From: Becca

Previous by Author: Re: STC certification program
Next by Author: Re: replacing text with visuals (was: introducing steps - translation issues)
Previous by Thread: RE: introducing steps
Next by Thread: RE: introducing steps

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

Sponsored Ads