To work with a domain everybody needs to use the terms unerringly. Create a glossary to create a common understanding of your domains.

Categories: / Domain

If names be not correct, language is not in accordance with the truth of things. If language be not in accordance with the truth of things, affairs cannot be carried on to success.
Confucius

A glossary is a tool to define terms of a domain. The glossary item template provides sections to distinguish between related terms and associate them to domain groups. Since every term is defined on its own page, additional resources may be attached easily.

In order to provide additional views on your domain, use categories, tags, and audiences.

Resources

Information Material

The following list of resources provides background information on creating and working with glossaries based on the projectdoc Toolbox for Confluence.

Resource	Short Description	Type
Create a Project Glossary	A step-by-step guide to create a glossary with the projectdoc Toolbox.	topic
Hands-on Tutorial	Get started with the projectdoc Toolbox: learning by doing	topic
Basic Concepts and Conventions for projectdoc	Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.	topic
Finding without Searching	How to organize a wiki to increase the findability of information.	Blog Article
Finding without Searching - applied!	How to use the projectdoc Toolbox to organize information in a Confluence wiki.	Blog Article

Doctypes

The following doctypes (blueprints based on the projectdoc Toolbox) provided page blueprints to create a glossary.

Resource	Short Description	Categories
Glossary Item	Glossary items are part of the domain glossary for the project. Glossaries support the team to use terms of the domain consistently in conversations and documentation.	/ Document / Entity
Section	Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.	/ Document / Part
Resource	Resources are books, webpages, videocasts relevant for the project. Add important information to your project about resources that lie outside the control of your team.	/ Document / Entity
Resource Type	Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.	/ Organisation / Specific
Category	Categories allow to set document instance of different doctypes in a hierarchy.	/ Organisation / Generic
Tag	Document the semantics of a tag. May also be used to document Confluence labels.	/ Organisation / Generic
Role	Defines a role with its responsibilities, tasks and requirements. Roles are incorporated by stakeholders who take interest in the project. The are also used to define the audience for documents.	/ Organisation / Generic

Macros

The following macros of the projectdoc Toolbox support creating or working with a glossary.

Resource	Short Description	Categories
Index Card Macro	Renders transcluded content fetched from documents of a result set.	Display / Query
Index Entries Table Macro	Renders a table of index entries.	Display / Query
Tour Macro	Renders a predefined list of documents in a table.	Display / Property
Section Macro	Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content.	Transclusion / Marker
Document Properties Marker Macro	A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.	Transclusion / Marker
Display Document Properties Macro	Renders a template with property references.	Display / Property
Display Table Macro	Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.	Display / Query

Space shortcuts

Child pages

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Resources

Information Material

Doctypes

Macros

About

Keep up-to-date!

Powered by