Re: A prescriptive language?

Subject: Re: A prescriptive language?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Bill Swallow" <techcommdood -at- gmail -dot- com>, "Rob Tovey" <robtovey -at- hotmail -dot- co -dot- uk>
Date: Wed, 16 Nov 2005 11:22:26 -0800

I think this is the same old "know your reader." If you're selling
a niche product to a niche market, for example IC logic and I/O
IP or DNA arrays, then your choice is between niche language
that will be undecipherable to a "global" audience that includes
Home Depot clerks and car salespeople, or an approach that is
easy for "most" to understand but may result in your customer base
constantly tearing out the first couple of chapters of everything you
publish and feeling insulted because you keep explaining to them
the basic building blocks of their professions. In either case, the
use of non-niche language is neither cost-effective nor particularly readable to the intended user.

Gene Kim-Eng


----- Original Message ----- From: "Bill Swallow" <techcommdood -at- gmail -dot- com>
My personal belief, which is grounded in cost savings and readability,
is that documentation should be written with a concise global
approach. Niche language (I assume you mean coloqialisms and the like)
can add confusion to readers, whether they are from different
countries, provinces, or social classes. IMO, keep it clean, concise,
and accurate. Written in this manner, information is easy for most to
understand.



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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archiver -at- 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/archiver%40techwr-l.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:

References:
A prescriptive language?: From: Rob Tovey
Re: A prescriptive language?: From: Bill Swallow

Previous by Author: Re: Cobra or COBRA
Next by Author: Re: A prescriptive language?
Previous by Thread: Re: A prescriptive language?
Next by Thread: Re: A prescriptive language?


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

Sponsored Ads


Sponsored Ads