-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #745 from mandy-chessell/dev-dojo
Add gecriptions of types of controlled glossary workflows
- Loading branch information
Showing
38 changed files
with
2,324 additions
and
23 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
site/docs/education/tutorials/building-egeria-tutorial/task-building-with-maven.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2,015 changes: 2,015 additions & 0 deletions
2,015
site/docs/services/omvs/glossary-workflow/glossary-workflow.drawio
Large diffs are not rendered by default.
Oops, something went wrong.
14 changes: 14 additions & 0 deletions
14
site/docs/services/omvs/glossary-workflow/harvested-glossary.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the Egeria project. --> | ||
|
||
### Harvested glossary | ||
|
||
Consider a situation where a new project needs to understand a new standard, or regulation, or a new field of operation. They may wish to collate and organize glossary terms from a variety of sources to help the team get up to speed with the new terminology. | ||
|
||
In the example below, the team working on a new sustainability initiative have assembled a glossary from the terms of other existing glossaries. | ||
|
||
![Aggregated Glossary](harvested-glossary.svg) | ||
|
||
The harvested style of glossary helps teams that do not have the time/resources to create their own glossary terms. | ||
|
||
--8<-- "snippets/abbr.md" |
4 changes: 4 additions & 0 deletions
4
site/docs/services/omvs/glossary-workflow/harvested-glossary.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions
20
site/docs/services/omvs/glossary-workflow/multi-level-glossaries.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the Egeria project. --> | ||
|
||
### Multi-level glossaries | ||
|
||
Consider an organization that wants to build a shared glossary for all of its divisions. Each division has expertise in different topics and there is inconsistent use of terms both within and across the divisions. | ||
|
||
A simple approach is for each division to have their own glossary to develop and agree on their terms. When a division has a term that they think should be in the company glossary they submit it for review. The term is reviewed by a cross-division team. If it is accepted, a copy of the term is added to the company glossary. If there are revisions to make, comments are passed back to the originating division. | ||
|
||
Whether the term is accepted or not, the originating team is free to continue to make changes to their copy of the term. They can then choose when they submit an updated version to the company glossary for review. | ||
|
||
![Multi-level glossaries](multi-level-glossaries.svg) | ||
|
||
|
||
In this example, the company glossary’s content is controlled. All editing of terms happens in the division glossaries. There is little support to reconcile differences in the definition of a term across the divisions. | ||
|
||
|
||
|
||
|
||
--8<-- "snippets/abbr.md" |
4 changes: 4 additions & 0 deletions
4
site/docs/services/omvs/glossary-workflow/multi-level-glossaries.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions
14
site/docs/services/omvs/glossary-workflow/open-contribution-glossary.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the Egeria project. --> | ||
|
||
### Open contribution glossary | ||
|
||
An open contribution glossary style is for creating new glossary content using subject matter experts that are distributed across the organization and may be contributing glossary content on an ad hoc, or as needed basis. | ||
|
||
The contributions are batched into small updates - for example, providing changes to a couple of terms plus adding a new relationship. The batches are reviewed by the team that own the central glossary and if they are acceptable, they are included in the glossary. | ||
|
||
![Open contribution glossary](open-contribution-glossary.svg) | ||
|
||
This style of glossary allows an organization to draw on the expertise from across its teams and build the glossary in an evolutionary manner. | ||
|
||
--8<-- "snippets/abbr.md" |
Oops, something went wrong.