Create a glossary to build consistent, common terminology
for the project. You can create new terms that are stored in the repository
and are included in the glossary. You can also add existing terms
from the repository into the glossary. Adding terms from the repository
enables you to use a term in more than one glossary.
About this task
Glossary terms can contain links to new and existing artifacts,
related terms, and synonyms. They also can contain comments and acronyms.
You can assign attributes to the glossary and view, filter, and sort
links to other artifacts using the sidebar.
Procedure
- Click
- In the New Glossary window, type a name for the glossary.
This name, which is displayed with the artifact in the project pages
and the Project Explorer, can include uppercase and lowercase characters
and spaces.
- Browse to a project and a folder for the glossary.
- (Optional) Add a tag to the new glossary.
- (Optional) Select a template for initial content for the
new glossary.
- (Optional) Click Next and select
the attribute groups that you want to apply to the glossary.
- Click Finish.
- Under the glossary name, click the <Enter
Description> placeholder and type a description for the
glossary.
- To create a new term and add it to the glossary:
- Click Add Term.
- At the <Enter Name> placeholder,
type the glossary term.
- At the <Enter Definition> field,
type the explanation for the glossary term.
- Add entries in the following fields: Related
Terms, Synonyms, and Acronyms.
- Click OK.
- To add an existing term from the repository into the glossary:
- Click Add Existing Term.
- In the Add Existing Term window at the Term field,
type an entry that provides a partial match for the term that is located
in the repository.
- Select the term from the results list and click OK.
- For information about adding links and other details to
the term, see Modifying a glossary and terms.
What to do next
The term defaults to a draft state. After an approval of
the term and its definition by the project stakeholders, change the
status from
Draft to
Published.
Obsolete terms can be a
Deprecated status.