TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: RE: my bad displays habit From:Odile Sullivan-Tarazi <odile -at- mindspring -dot- com> To:Paul Goble <pgcommunication -at- gmail -dot- com> Date:Wed, 3 Mar 2010 08:25:58 -0800
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.
Odile
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: http://www.doctohelp.com
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: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-