Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A In searchable documentation, what function does a glossary serve?

I have several online Help projects for various products and only one currently uses a glossary. We made an exception to define words that are key to the product, which is a sister-product and buil...

posted 7y ago by Rachel‭  ·  last activity 5y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T07:00:02Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/30197
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Rachel‭ · 2019-12-08T07:00:02Z (almost 5 years ago)
I have several online Help projects for various products and only one currently uses a glossary. We made an exception to define words that are key to the product, which is a sister-product and built on the same code; so key terms had to be updated for the audience and use, and for that reason, we use a glossary which helps customers who use both products. I also think it is a good tool for keeping track of acronyms. Last, our users have a wide-range of technical expertise, so we have to cover the bases and define things that might seem obvious, but are hopefully helpful. I think polling your users is valuable as well as asking your trainers for their opinions.

#1: Imported from external source by user avatar System‭ · 2017-09-12T19:43:11Z (about 7 years ago)
Original score: 1