TERMINILOGY AND DEFINITIONS SAMPLE PAGE PLUS

If you’d prefer an out-of-the-box Confluence glossary solution, you could try the Glossary plugin from the Atlassian Marketplace. Want to learn more about managing your topics and snippets of documentation in Confluence?Īdvanced Features Using the Glossary Blueprint

Alternatively, the MultiExcerpt app lets you pull together multiple definitions in a single view.įor larger glossaries, we recommend creating a page for each term, and summarizing the glossary entries using, for example, the built-in Children Display macro or the Content by Label macro, in combination with the Excerpt macro: Using the Expando macro, you can choose to display definitions collapsed by default to make scanning simple. We did this for one of our app's documentation. A Simple Glossary in ConfluenceĪ typical approach to glossary building in Confluence is to create a page that contains a list or table of terms and their definitions.

can enjoy access to this source of information – and could potentially contribute their own terms and definitions.

TERMINILOGY AND DEFINITIONS SAMPLE PAGE PLUS

Everyone within your organization, plus customers, partners etc. This is often referred to as ‘terminology management’.Ĭonfluence is the perfect place to create and manage a glossary centrally. It familiarizes readers with key words and abbreviations. Building a glossary is also the first step to truly consistent wording – and it increases understanding, too. Building a Glossary in ConfluenceĪ glossary is an alphabetical list of terms and their corresponding definitions. What’s more, I’ll show you a way to check your Confluence content for terminology and writing style. This blog post describes how you can build a glossary in Confluence to ensure terminology consistency.

This is where terminology management comes to the rescue. But when larger groups of authors collaborate to write documentation, they tend to use different words for the same things – such as jargon, or incorrect or obsolete terms. We constantly refer to it in meetings, specs and technical documentation, but often do so in different ways.Ĭonsistent wording is key to delivering clear, readable documentation. It seems everyone – from customers to consultants, developers and tech writers – has their own name for this UI element. I recently discussed this very issue with one of our Atlassian consultants. What would you call the image below? A ‘drop-down list’? A ‘pull-down’ or ‘select list’? A ‘drop-box’?

Terminilogy and definitions sample page