Definitions vs. Glossary

Subject: Definitions vs. Glossary
From: Alisa Dean <Alisa -dot- Dean -at- MCI -dot- COM>
Date: Wed, 4 Dec 1996 11:09:00 -0700

Mike Dean wrote:
>I have a list of terms that apply either to our applications or to
>Windows terms that our users may have a limited understanding of. These
>are appended to my help files. They started life as a list of
>definitions, but it looks more like a glossary to me now.

>The apps are medical transcription software and administrative system
>tools.

>Any input on what this should be called? I lean to Glossary. Unable to
>find any specific definition of the difference, just have a gut
>feeling. Could someone define (gloss) these?

In my current template, I had a Glossary section with subheadings of
Acronyms and Terms. After much discussion with my fellow TWs, we decided
that it was unnecessary and potentially incorrect to do so (one discussion
was centered around the difference between an acronym and an abbreviation).
So we combined the entire section under the heading Terminology. Under
this, we have a two column table that has the term, acronym, or abbreviation
in the first column, and its corresponding definition in the second
column. The table is sorted by the first column.

I think it made a cleaner look on the page. Hope this helps.

Alisa Dean
Sr. Technical Writer
alisa -dot- dean -at- mci -dot- com


Previous by Author: Writing User Guide for Code
Next by Author: FrameMaker Discrepancy
Previous by Thread: Re: HTML Conversion Tools
Next by Thread: [no subject]


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

Sponsored Ads


Sponsored Ads