atw: Re: Use of Conventions table
- From: "Matilda Reich" <matildar@xxxxxxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Thu, 19 Feb 2004 14:54:05 +1100
Nigel,
Conventions section can be in a table format. It simply describes the mode of
expression you use consistently to describe common key strokes or operations.
Use 2 headings like:
Operation or Element Format Used in this Manual
Directory paths c:\program files\Iexplore
References to other docs Refer to Windows - Getting Started
for more info....
Simultaneous keystrokes Ctrl + Atl + Delete
Sequential keystrokes F6 then NumLock
regards,
Matilda Reich
----- Original Message -----
From: Nigel Dawes <NigelD@xxxxxxxxxxxxxxxx>
To: <austechwriter@xxxxxxxxxxxxx>
Sent: Monday, February 16, 2004 2:15 PM
Subject: atw: Re: To press while... or hold?
> Bruce,
>
> Pardon my ignorance, but can you offer me some advice as to how a
> Conventions section works.
> I will infact need to replicate this several times.
>
> Rgds
> Nigel
>
> -----Original Message-----
> From: bja [mailto:bashley@xxxxxxxxxxx]
> Sent: Monday, 16 February 2004 2:04 PM
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: To press while... or hold?
>
>
> Probably the wrong way round Nigel.
>
> "While pressing the Shift key, click on the RTU No. button" would be better.
> Doing it your way might not work.
>
> Also, if you need to detail this a number of times, it would be best to put
> the process into a 'Conventions' section near the front of the document and
> then use the abbreviated outcome ie Press Shift+<RTU No.> (with or without
> the brackets).
>
> Cheers.
>
> Bruce Ashley
>
>
>
>
> > -----Original Message-----
> > From: austechwriter-bounce@xxxxxxxxxxxxx
> > [mailto:austechwriter-bounce@xxxxxxxxxxxxx]On Behalf Of Nigel Dawes
> > Sent: Monday, 16 February 2004 1:57 PM
> > To: 'austechwriter@xxxxxxxxxxxxx'
> > Subject: atw: Re: To press while... or hold?
> >
> >
> > Thanks again, Sonja.
> > I went with "while".
> >
> > ...Press the Shift key while clicking the RTU No. button.
> > The blocksizes and options available for the specified RTU display, as
> > illustrated below.
> >
> > Note: Pressing the Shift key while clicking the RTU No. button updates
> > the parameters in the Options dialog for the specified RTU.
> >
> >
> > Rgds
> > Nigel
> >
> > -----Original Message-----
> > From: Sonja McShane [mailto:smcshane@xxxxxxxxxxx]
> > Sent: Monday, 16 February 2004 1:39 PM
> > To: austechwriter@xxxxxxxxxxxxx
> > Subject: atw: Re: To press while... or hold?
> >
> >
> > To me, when you press:
> > * x and y, you press them both at the same time
> > * x, then y (or x, and then y), you press one after the other.
> >
> > But to be totally clear (albiet more wordy), I guess it would be best
> > to write something along the lines of: "To update all
> > parameters, press Shift
> > while [pick one: simultaneously/at the same time/also]
> > clicking the button."
> >
> >
> > A computer literate audience sure is easier to write for!
> >
> > It really comes down to Nigel's audience and the company style.
> >
> > Nigel, what did you end up writing?
> >
> > Sonja
> >
> > -----Original Message-----
> > From: austechwriter-bounce@xxxxxxxxxxxxx
> > [mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Naomi Kramer
> > Sent: Monday, 16 February 2004 10:13 AM
> > To: austechwriter@xxxxxxxxxxxxx
> > Subject: atw: Re: To press while... or hold?
> >
> >
> > I'm not sure I got my point across. I admit I wrote and fired it off
> > very quickly :)
> >
> > What I meant is... To my way of thinking, many users (esp. relatively
> > computer illiterate) would take "To update all parameters, press the
> > Shift key and click the button." to mean "press SHIFT, then click",
> > whereas they
> > need to keep pressing while clicking.
> >
> > -----Original Message-----
> > Or maybe the shorter version:
> > "To update all parameters, press the Shift key and click the button."
> >
> > Naomi says: I'd take that to mean 'press SHIFT, then click'. If that
> > was what the sentence meant, then that would be how you would
> > write it. But
> > that's not what the sentence means, so it's OK as is, by me anyway :-)
> >
> > **************************************************
> > To post a message to austechwriter, send the message to
> > austechwriter@xxxxxxxxxxxxxx
> >
> > To subscribe to austechwriter, send a message to
> > austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject
> > field.
> >
> > To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx
> > with "unsubscribe" in the Subject field.
> >
> > To search the austechwriter archives, go to
> > www.freelists.org/archives/austechwriter
> >
> > To contact the list administrator, send a message to
> > austechwriter-admins@xxxxxxxxxxxxx
> > **************************************************
> >
> >
> > **************************************************
> > To post a message to austechwriter, send the message to
> > austechwriter@xxxxxxxxxxxxxx
> >
> > To subscribe to austechwriter, send a message to
> > austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject
> > field.
> >
> > To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx
> > with "unsubscribe" in the Subject field.
> >
> > To search the austechwriter archives, go to
> > www.freelists.org/archives/austechwriter
> >
> > To contact the list administrator, send a message to
> > austechwriter-admins@xxxxxxxxxxxxx
> > **************************************************
> > --
> > Message protected by MailGuard: e-mail anti-virus, anti-spam and
> > content filtering. http://www.mailguard.com.au/mg
> >
> > **************************************************
> > To post a message to austechwriter, send the message to
> > austechwriter@xxxxxxxxxxxxxx
> >
> > To subscribe to austechwriter, send a message to
> > austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject
> > field.
> >
> > To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx
> > with "unsubscribe" in the Subject field.
> >
> > To search the austechwriter archives, go to
> > www.freelists.org/archives/austechwriter
> >
> > To contact the list administrator, send a message to
> > austechwriter-admins@xxxxxxxxxxxxx
> > **************************************************
>
> **************************************************
> To post a message to austechwriter, send the message to
> austechwriter@xxxxxxxxxxxxxx
>
> To subscribe to austechwriter, send a message to
> austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
>
> To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
> "unsubscribe" in the Subject field.
>
> To search the austechwriter archives, go to
> www.freelists.org/archives/austechwriter
>
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
> --
> Message protected by MailGuard: e-mail anti-virus, anti-spam and content
> filtering. http://www.mailguard.com.au/mg
>
> **************************************************
> To post a message to austechwriter, send the message to
> austechwriter@xxxxxxxxxxxxxx
>
> To subscribe to austechwriter, send a message to
> austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
>
> To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
> "unsubscribe" in the Subject field.
>
> To search the austechwriter archives, go to
> www.freelists.org/archives/austechwriter
>
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
Other related posts:
- » atw: Re: Use of Conventions table
