TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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-
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-
