RE: Choosing and managing customer-facing terminology

Subject: RE: Choosing and managing customer-facing terminology
From: "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>
To: 'Julian Cantella' <jcantel -at- us -dot- ibm -dot- com>, "'techwr-l -at- lists -dot- techwr-l -dot- com'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 21 Sep 2011 18:19:03 +0000

I try to use clear, plain, basic English in my user guides.

If someone explains an interface to me in "engineer-ese" or "programmer-ese," I will first explain it to myself and write down. Then I will read it back to the SME, asking them, "Is this basically what you said?"

-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Julian Cantella
Sent: Wednesday, September 21, 2011 1:56 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Choosing and managing customer-facing terminology

Hello,

I'm curious about how writers choose terminology that will be exposed to
customers. In particular, I'm thinking about text that is highly visible
and informs the users' view of the product, like embedded assistance in
software documentation.

Do you use whatever terminology your subject matter experts provide?
Consult domain publications and other products in the field?

When you decide what terminology you'd like to use, how do you enforce it
and ensure that everyone (other writers for the same product, developers,
maybe even marketing) is on the same page? Do you record your decision in
a common database?

And finally, what happens when you and your subject matter experts
disagree? Do you try to put alternatives in front of users?

This topic is pretty broad, but it's an important one that has a big
impact on users' perception of product and documentation quality.


Sincerely,

Julian Cantella
Information Developer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as ccardimon -at- m-s-g -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/ccardimon%40m-s-g.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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat

Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Choosing and managing customer-facing terminology: From: Julian Cantella

Previous by Author: RE: Dilemma - LinkedIn Requests
Next by Author: RE: Choosing and managing customer-facing terminology
Previous by Thread: RE: Choosing and managing customer-facing terminology
Next by Thread: Re: Choosing and managing customer-facing terminology


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

Sponsored Ads


Sponsored Ads