A directory of resources inthe field of technical communication.

Articles>Editing>Glossary

3 found.

About this Site | Advanced Search | Localization | Site Maps

 

1.
#21216

The ABCs of Writing a Technical Glossary   (peer-reviewed)   (members only)

This article identifies and explains format rules, style rules, and lexicographic conventions that have been shown to improve clarity and precision in a technical glossary. Rationale for the rules of language, presentation, and style are examined. The need to allow flexibility in following the rules is discussed in terms of strengthening the technical merit and vitality of the glossary. This article also describes the computer-display techniques and file-management system used in committee to develop U.S. Federal Standard 1037C, Glossary of telecommunication terms, and to display the results both in the meeting room and on the Internet between meetings.

Gray, Evie, William Ingram and Dennis Bodson. Technical Communication Online (1998). Articles>Editing>Technical Editing>Glossary

2.
#26458

Defining Glossaries   (peer-reviewed)   (members only)

Glossaries are lists of specialized word definitions contained in technical documentation that can assist the nontechnical user to comprehend fully the technical topic at hand. In a joint project with SAS Institute, I sought to discover how glossaries were first developed, what guidelines are available for technical writers in the writing of glossaries, and what rhetorical technique might be of value for glossary writers. I found that glossaries are much more than simple word lists; they are, in fact, an opportunity for the technical writer to outline and protect the parameters of technical discourse between a company and its customers across multiple communications channels, and different languages. In an increasingly global technical environment, an explicit connection between the rhetorical technique of definition and the writing of glossary definitions should be made to aid technical writers in this task.

Tackabery, Michelle Kidd. Technical Communication Online (2005). Articles>Editing>Glossary

3.
#21410

How to Write Glossaries   (Word)

Glossaries can be quite difficult to write, mainly because some definitions require so much research. While many definitions can be found online, others cannot. For these, you will have to read standards, Requests for Comments (RFCs), and books—a lot of work for a three- or four-line definition!

Docsymmetry (2003). Articles>Editing>Glossary

There are 28 readers currently online: 2 registered users and 26 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon