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.
Yabbut, if nobody tells the user which words are on this
list, they are still gonna try to look up "way cool button"
and be awfully disappointed/frustrated when it's not there.
I can see creating a controlled vocab list for the doc
itself, but in a user-friendly index, synonyms are essential,
and the more the merrier.
my two cents. ;-)
-Sue Gallagher
>
> From: John Posada <JPosada -at- book -dot- com>
> I think the purpose of the controlled list is to eliminate the need to
> include terms such as "way cool button" in the index as a synonym for "Run".
>
>
> >Isn't the purpose of an index to provide synonyms? 20
> >people reading documentation will think of 20 different
> >words for the same concept when they consult the index.
> >(Or am I missing the point?)
>
> >
> >> Well, I have a suggestion inspired by my former days
> >> as a technical services librarian. I suggest you put
> >> together what they call a "controlled vocabulary."
> >>This is a list of terms that serves as an authority.
>