RE: in search for better tools

Subject: RE: in search for better tools
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: GILLIOTTE Valérie <vgilliotte -at- mega -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 8 Dec 2009 14:36:54 -0700

GILLIOTTE Valérie wrote:

> The problem is that variables are not necessarily names of products. It can
> be names of concepts. We write our documentation in French, where there is
> a gender problem, unlike in English. I can't think variables can work here,
> or maybe I did not understand all of it. ??

As Robert noted, this can be dealt with by creating separate variables for the concept with a definite artice, indefinite article, or no article. Even, if necessary, initial-caps variables for beginning sentences, plurals, or other special cases. If you apply good, consistent naming conventions so that all the variations of each variable group together in the list, this isn't hard to manage.

To illustrate, here are some example variable names (in angle brackets), followed by alternative definitions that might be used in different books (forgive me if I screw up the French; it's been many years since those college classes):

<animal-definite>: le chien, la chienne, le chat
<animal-Definite>: Le chien, La chienne, Le chat
<animal-indefinite> un chien, une chienne, un chat
<animal-Indefinite> Un chien, Une chienne, Un chat

I've created books that contain well over a hundred variables. I don't know if there is a limit, but I'll bet you don't encounter it. :-)


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------






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

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. 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.

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


Follow-Ups:

References:
in search for better tools: From: GILLIOTTE Valérie
RE: in search for better tools: From: Combs, Richard
RE: in search for better tools: From: GILLIOTTE Valérie
Re: in search for better tools: From: Robert Lauriston
RE: in search for better tools: From: GILLIOTTE Valérie

Previous by Author: RE: in search for better tools
Next by Author: RE: in search for better tools
Previous by Thread: RE: in search for better tools
Next by Thread: Re: in search for better tools


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

Sponsored Ads


Sponsored Ads