RE: Chattiness in manuals

Subject: RE: Chattiness in manuals
From: "Claire Conant" <Claire -dot- Conant -at- Digeo -dot- com>
To: SaraTörök <sara -dot- torok -at- se -dot- nucletron -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 17 Oct 2006 06:55:18 -0700

I'm with you, Sara.

As an editor, I'd strike out this type of writing in a heartbeat, without thinking twice about it. People aren't perusing user guides or help manuals (online or printed) for entertainment or amusement, and they don't read them like a novel (front to back or even whole sections word for word.) It's not fiction or a magazine story. It's help - fast and to the point - so they can move on and do more important things.

If I were buying a user guide or manual that had this content, well, I just wouldn't. I almost didn't buy a manual because it used the word "utilize" because a) that's my pet peeve, and b) it's not fast and to the point.

Just my perspective.

Claire




Sara Torok says:

Seriously, this style could be fine in a tutorial, but in a reference
manual, online help, or the like - NEVER.
I'm looking for an answer to my question, a solution to my problem, facts,
facts, facts. Don't waste my time with chitchat, jokes and anecdotes. I'm
not up for it right now. I'm trying to do my job.

Maybe it's cultural...

Regards
Sara
______________________
Sara Török
Technical Writer



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

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


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


Follow-Ups:

Previous by Author: Re: Release notes and DITA
Next by Author: RE: Chattiness in manuals
Previous by Thread: Re: Chattiness in manuals
Next by Thread: Re: Chattiness in manuals


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


Sponsored Ads