Child pages
  • Glossary (Business Use Case)

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »


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

Categories

Summary

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.

Resource Short Description Type
A step-by-step guide to create a glossary with the projectdoc Toolbox.
topic
Get started with the projectdoc Toolbox: learning by doing
topic
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
topic
Finding without SearchingHow 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 provided page blueprints to create a glossary.

Resource Short Description Categories
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.
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.
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.
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.
Categories allow to set document instance of different doctypes in a hierarchy.
Document the semantics of a tag. May also be used to document Confluence labels.
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.

Macros

The following macros support creating or working with a glossary.

Resource Short Description Categories
Renders a table of index entries.
Renders a predefined list of documents in a table.
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.
A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Renders a template with property references.
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
  • No labels