RE: RE: my bad displays habit

Subject: RE: RE: my bad displays habit
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
To: "Odile Sullivan-Tarazi" <odile -at- mindspring -dot- com>, "Paul Goble" <pgcommunication -at- gmail -dot- com>
Date: Wed, 3 Mar 2010 08:56:09 -0800

Exactly. Standards should ALWAYS be geared toward audience.


-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Odile Sullivan-Tarazi
Sent: Wednesday, March 03, 2010 8:26 AM
To: Paul Goble
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: RE: my bad displays habit

That's a good point!

We have tried to go this route with screenshots, though I'd not made
this connection. In addition, we do not show screenshots at each
step. We include them when the UI is interesting, unusual, or
complex. The routine stuff we don't keep repeating.

We are also writing for an audience of developers. I realize there
are some environments (audience, situation, type of doc) in which a
screenshot at each step makes sense.


At 4:01 PM -0600 3/2/10, Paul Goble wrote:
>Odile wrote:
>> What we do, rather than including a separate results line, is locate
>> the user in that new UI at the beginning of the step that follows.
>> 1. Do this.
>> 2. In the Such and Such dialog, do that.
>I gravitate toward this solution for another reason: it facilitates
>tightly-cropped screen shots which show the action being performed.
>The "such and such appears" style lends itself to static, cursor-less
>screen shots of whole windows.
>Graphics and text contribute equally to the active or passive "voice"
>of a passage.
>Paul Goble


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

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:

Re: RE: my bad displays habit: From: John Posada
Re: RE: my bad displays habit: From: Paul Goble
Re: RE: my bad displays habit: From: Odile Sullivan-Tarazi

Previous by Author: Re: Survey sez: your favorite local-drive search tool
Next by Author: RE: Profanity in the workplace
Previous by Thread: Re: RE: my bad displays habit
Next by Thread: RE: Re: my bad displays habit

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

Sponsored Ads