Re: Retaining author's voice, was How to Use English PunctuationCorrectly - wikiHow

Subject: Re: Retaining author's voice, was How to Use English PunctuationCorrectly - wikiHow
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 16 Jul 2007 14:21:27 +1000

Dori Green wrote:
> I was taught that technical writing is "writing to inform". Just the facts, Ma'am. Personality and "voice" are not among the required deliverables -- in fact, one of the most important functions of an editor is to blend the different styles and "voices" of a team documentation effort into one cohesive unit.
>
> _Depending on the audience_ and the _customer's requirements_, I might insert a light and breezy "voice" for ad copy or a magazine promo article -- or I might engage a professorial stentorian resonance for an ivy-covered journal.
>

I think we've all been using the word "voice" in two different
ways:

* The "tone" of a piece -- For example, the formality
of language and level of vocabulary should differ between
a tutorial or beginner's user's guide and a technical
reference manual.

* Writing style -- All writers have their own style.
Even when all the writers at a company are adhering
to the style guide and writing grammatically correct
prose, they each will write in a slightly different
way. Perhaps one writer has favorite phrases that he
uses often, or another writer tends to explain things
using more analogies.

Editors need to make sure that all documentation from a
company sounds the same, appropriate to the audience level.
OTOH, that doesn't mean that the documentation has to sound
like it was written by a robot, or all written by the editor!
I think we should strive to keep some of the writer's style
in documentation without compromising consistency, appropriateness,
or common corporate "feel."

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.


Follow-Ups:

References:
RE: Retaining author's voice, was How to Use English PunctuationCorrectly - wikiHow: From: Dori Green

Previous by Author: Re: Managing your project email
Next by Author: Re: Newsweek Article: "The Sad Fate of the Comma"
Previous by Thread: RE: Retaining author's voice, was How to Use English PunctuationCorrectly - wikiHow
Next by Thread: RE: Retaining author's voice, was How to Use English PunctuationCorrectly - wikiHow


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


Sponsored Ads