atw: Re: style guide --- yr expertizzz plzzz
- From: "Bob Trussler" <bob.trussler@xxxxxxxxx>
- To: austechwriter@xxxxxxxxxxxxx
- Date: Tue, 16 Sep 2008 14:02:58 +1000
Unless the position on the screen is ambiguous such as when there are two
lists or two columns, I usually write in this format:
On the Download screen, at the File Name field, type the name of the file.
On the Payment screen, in the Payment Type pane, at the Card Name field,
select the card name from the drop down list.
This does rely on a screen with well labelled parts. This may lead to you
having a little chat to the developers in which you explain that
three consecutive screens titled Payment is just not good enough.
Bob T
2008/9/16 Matthew da Silva <mdasilva@xxxxxxxxxxx>
> One issue I'm not finding described in Read Me Fist! Is how to indicate
> position on-screen, for instance: "go to the right-hand side of the
> screen".
>
> Should 'right-hand' be hyphenated here? Following the book would suggest
> that, yes, the expression 'right-hand' should be hyphenated. The problem
> is that there is client resistance to the formulation.
>
>
> -----Original Message-----
> From: austechwriter-bounce@xxxxxxxxxxxxx
> [mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Janice Gelb
> Sent: Thursday, 11 September 2008 5:27 PM
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: style guide --- yr expertizzz plzzz
>
> On 11/09/08 04:14 PM, tpdhome@xxxxxxxxxx wrote:
> > A style guide should also support and be supported by a robust
> template.
> > You can explain features of the template such as styles, macros,
> > shortcut keys, boilerplate text, etc in the style guide.
> >
> > Like many others, I like to include a list of pet hates and commonly
> > made mistakes, especially those relevant to the topic. And remember,
> > eschew complexity in terminology!!
> >
>
> I think that an explanation of how to use corporate templates
> is important but personally, I'd split the subject matter and
> have two guides - one for template usage and one for writing.
>
> -- Janice
>
> ***********************************************************
> Janice Gelb | The only connection Sun has with
> janice.gelb@xxxxxxx | this message is the return address
>
>
> **************************************************
> To view the austechwriter archives, go to
> www.freelists.org/archives/austechwriter
>
> To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx
> with "unsubscribe" in the Subject field (without quotes).
>
> To manage your subscription (e.g., set and unset DIGEST and VACATION
> modes) go to www.freelists.org/list/austechwriter
>
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
> **************************************************
> To view the austechwriter archives, go to
> www.freelists.org/archives/austechwriter
>
> To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
> "unsubscribe" in the Subject field (without quotes).
>
> To manage your subscription (e.g., set and unset DIGEST and VACATION modes)
> go to www.freelists.org/list/austechwriter
>
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
>
--
Bob Trussler
Phone 0418 661 462
Other related posts:
