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?

Some thoughts: I would ask the users instead of guessing whether they use the in-page popups. Do a (small) survey. Some users may not use the glossary because they are unaware of it but would if ...

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

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T07:00:00Z (about 5 years ago)
Source: https://writers.stackexchange.com/a/30174
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar System‭ · 2019-12-08T07:00:00Z (about 5 years ago)
Some thoughts:

- I would ask the users instead of guessing whether they use the in-page popups. Do a (small) survey.
- Some users may not use the glossary because they are unaware of it but would if they knew. Ask in the survey.
- While I don't often use a glossary, the one time that I do it is usually indispensable.
- If you dispense with the glossary, make sure that all terms that are not easily found on the web are defined somewhere in the text of your documentation. Context may not explain them all equally well.
- A glossary might serve as a guideline for the writers (!) on how to use certain terms. If you don't have one, each writer might use a term differently.
#1: Imported from external source by user avatar System‭ · 2017-09-11T07:51:11Z (over 7 years ago)
Original score: 6