Re: Boring documentation?

Subject: Re: Boring documentation?
From: "Julie Stickler" <jstickler -at- gmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 3 Apr 2006 15:58:13 -0400

Every time we start another thread about "interesting" manuals,
writing styles, making the documentation "accessable" and so on I have
to wonder, does anyone on this list localize their documentation?

We translate our documentation into about a dozen languages, and many
of the guidelines for writing for a global audience are in direct
opposition to writing a folksy, Dummies-style book. We're supposed
to write short, clear sentences. We're supposed to avoid humor
because it doesn't translate. Avoid examples like sports metaphors
that might not be understood by other cultures. If I want to stay on
the good side of our localization manager, I CAN'T write a book that
looks anything like one of the Dummies books.

I don't write formal manuals because I am incapable of writing an
interesting book. I do it because that is the writing style that best
meets the needs of both my users and the company that employs me as a

Julie Stickler

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!.

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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 lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: Friday Fun: What Pet Peeve makes you puke?
Next by Author: Re: List formats?
Previous by Thread: RE: Quick question about 'hence'?
Next by Thread: Re: Boring documentation?

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

Sponsored Ads