Re: TECHWR-L Digest - 11 Jan 1999 to 12 Jan 1999

["Hyde, Barb # IHTUL" <Barb -dot- Hyde -at- TULSA -dot- CISTECH -dot- COM>]

> ----------
> From:         Automatic digest
> processor[SMTP:LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU]
> Reply To:     Technical Writers List; for all Technical Communication
> issues
> Sent:         Wednesday, January 13, 1999 12:00 AM
> To:   Recipients of TECHWR-L digests
> Subject:      TECHWR-L Digest - 11 Jan 1999 to 12 Jan 1999
>
>
        Carolyn,
        We use gerunds in the heading of step-by-step instructions for any
task.  Using gerunds cues readers that they will be doing something.  The
other reason we opted for gerunds for processes is that in many cases the
title of the dialog box from which the task is performed is the imperative.
To use your example, the dialog box would be referred to as Add a Note
dialog box. Because we provide a description of the dialog box and the
step-by-step instructions for using it, we use Add a Note Dialog Box for the
reference heading and Adding a Note for the process heading.

        Philosophically, is the purpose of the section to order the reader
to add a note or is it to tell the reader how to add a note when they feel a
note is needed? In the first case the imperative is appropriate. In the
second case, the gerund is appropriate.

        >Carolyn Davidson writes:
> >I'm one week into a new job as the sole technical writer in a medium-
> >sized company that has just begun to document their policies and
> >procedures in print and in online Help. The style guide, developed by a
> >consultant before I arrived, calls for the avoidance of gerunds in
> >titles in favour of imperatives (e.g., "Add a note" instead of "Adding a
> >note"). I understand that they want to use a strong, directive tone in
> >their manuals, but I'm concerned that consistent use of the imperative
> >may cause readers to "Add a note" (for example) where it's not
> >appropriate.
>


 From ??? -at- ??? Sun Jan 00 00:00:00 0000=