Re: Doc Design and Convention

Subject: Re: Doc Design and Convention
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 3 Nov 2009 09:26:14 -0800

Exactly. Perhaps you could improve the routing algorithms for a GPS
navigation system by incorporating information on signal
synchronization, but it would be transparent to the user.

I think Chris's perspective on end-user docs reflects his background
as a developer and writing for developers.

On Tue, Nov 3, 2009 at 9:10 AM, Sharon Burton <sharon -at- anthrobytes -dot- com> wrote:
> I think you're conflating something. I think you're confusing tell the users
> about infrastructure with telling them useful information. For example:
> The going-to-a-party use case: I want to arrive at the party. (notice this
> is a goal, which generally good use cases are stated as)
> * Expert (I know the town and the person throwing the party): The
> information I'm told: The party is at Becky's house. I drive to her house. I
> don't need more info and will resent anyone in the car directing me.
> * Intermediate: (I know the town but not the location of the party) The
> information I'm told: The party is at Becky's house. I need cross streets or
> general area to drive towards and then turn by turn to find the house.
> * Beginner: (I don't know the town and may or may not know the location of
> the party) The information I'm told: The party is at Becky's house. I need
> to be told every turn and be guided to find the house.
> Once you know your audience, you adjust the level of info accordingly. If
> you aren't sure of your audience, you layer the information for each level.
> At no level do we need to know how traffic signals are synchronized.
> But design documents for creating the product may very well do the
> equivelent of explaining how the traffic signals are synchronized. Because
> that's the infrastructure around which the users are doing what they need to
> do. But the users don't care about that - they have a goal and want to
> achieve that goal.

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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: Doc Design and Convention: From: Chris Despopoulos
RE: Doc Design and Convention: From: Sharon Burton

Previous by Author: Re: Narrative Technical Writing
Next by Author: Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)
Previous by Thread: RE: Doc Design and Convention
Next by Thread: Re: Doc Design and Convention

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

Sponsored Ads