Re: introducing steps

Subject: Re: introducing steps
From: "Michael West" <mbwest -at- bigpond -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 19 Oct 2011 09:31:23 +1100

In instructional writing, less is usually more. My preference is to use a
heading, rather than body text, to introduce a list of instructions. This
gives the instruction set greater visibility on the page for the
skim-reader. I would even recommend using a consistent, distinct heading
style rather than hierarchical headings for instruction sets, so that they
can be more easily spotted by page flippers. (You don't think people
actually READ your stuff, do you?) Ensure that only instructions and their
illustrative graphics appear under these headings; use "see" references in
instructions to point readers elsewhere for discussions, descriptions or
explanations.



If you create the heading -



To install Sigil



- (without the colon, please note) you can then omit any introductory clause
and simply list the instructions without violating any traditional rules of
grammar. Remember that some readers - the most attentive ones, in fact - are
distracted by what they recognise as grammatical errors, and there is no
benefit in annoying them.



There is nothing "ungraceful" about the traditional requirement for an
independent clause when introducing a list made up of independent clauses.
Dependent clauses should not just be left with their arses hanging out. The
bare infinitive, end-punctuated with a colon, is a sentence fragment - a
clear violation of classical English grammar, though it is often seen in the
wild. On this point, your teacher stands on firmer ground than you.

--

Mike West



------------------------------



On Oct 18, 2011 11:47AM, Becca wrote:

> I'm taking a class in technical writing. My teacher says never to
introduce a series of steps with an infinitive (To install Sigil) but to use
an independent clause ("To install Sigil, follow these steps:" or words to
that effect. To me, the clause "follow these steps" is imlied by the fact
that steps follow. Still, it's the teacher, so I have to follow her style.

>

> Is there a more graceful way to introduce steps? how do yo do it? I'm
pretty much coming up dry.

>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

Previous by Author: RE: Help - my consultants cannot write!
Next by Author: RE: introducing steps
Previous by Thread: RE: introducing steps
Next by Thread: RE: introducing steps


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

Sponsored Ads


Sponsored Ads