Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
366 changes: 208 additions & 158 deletions docs/glossaries/mrg.termdsn.documentation.yaml

Large diffs are not rendered by default.

1,092 changes: 232 additions & 860 deletions docs/glossaries/mrg.tev2.documentation.yaml

Large diffs are not rendered by default.

366 changes: 208 additions & 158 deletions docs/glossaries/mrg.tev2.terms.yaml

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions docs/overview/10-purpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,21 @@ export const mark = ({children}) => (
<span style={{ color:'black', backgroundColor:'yellow', padding:'0.2rem', borderRadius:'2px', }}>
{children}
</span> );

### Who benefits

For who are we doing this, what can this person do with it and what is the unique result?

Are you going to be faster, better, easier-going in writing texts? Will you be better understood by a larger audience?

The brief answer is *yes*. Just imprint this paragraph for more backing:

#### Why are we doing this?

**Authors and curators** of texts can follow this guideline for terminology design in order to **create their terminology**, **invent smart criteria to distinguish their concepts from others**, thereby identifying their own concepts clearer, understand their peers better and finally **be understood better** and quicker by others.

Oops the magic word is in there! Have you been able to locate it? No? Keep going!

### Reality check

Most term definitions in the world do not comply with the distinguishing-criteria rule, and that’s the uniqueness of this Method: it’s easy to follow and the result is an improved terminology.
128 changes: 128 additions & 0 deletions docs/overview/20-design-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,131 @@ import useBaseUrl from '@docusaurus/useBaseUrl'
/>

## Summary
You need to understand first, to be understood.

## Terminology design aids

“Why do we need to design terminology? Can’t we simply write our ideas down, look up some definitions and add them, or search for some explanatory texts if clear definitions lack in the heat of the writing process?"

"We don’t have a problem, do we? Why all the fuzz and juggling all these terms and definitions about terms and definitions? It’s not getting better, is it?

"Please let me just write my document and add some glossary items and we’re done. We skip all the academic hassle about *meaning, concepts, artefacts* and what have we. Let’s get work done!”

### Do not proceed if

You recognize a few of those remarks above? If communication and understanding each other were just that easy, we could leave the hard part out. But **we can't skip the design of terminology** if we want to convey a (new) concept.

**Please do not proceed with this Method if you're a sender, only sending or broadcasting.**

Because you need to understand first, to be understood.

### Principles

#### Iterate through concepts

The idea is that anyone willing to explain some concepts by (first) understanding the perception of the receiving party will go through this loop for every term that is unclear, conflates, or is otherwise not fully understood.

::: note At least one criterium?
At least one clear generally applicable criterium should come out of this step-by-step per term.
:::


1. Start writing your objectives and ideas, and identify the concepts behind the terms you use ([why](#why-objectives)-[what is it](#what-identifying)?)
2. Write the concept in a specific way: formulate criteria ([why](#why-criteria)-[how](#how-criteria)-[what is good](#what-good-criteria)?) when you expect confusion to arise
3. As long as a term is not understood by the target group: replace it with your criteria ([why](#why-replace)-[how](#how-replace)?)
4. As soon as it’s understood: define the term with those criteria and replace the criteria in the text with the term. ([why]((#why-back-terms)-[how](#how-back-terms)?)


#### 1. Start writing your objectives and ideas, and identify the concepts behind the terms you use

##### why writing your objectives and ideas down [#why-objectives]
You want to be understood and seek support for your plans or ideas. To guide this process, it's good to have a reference.

##### what is "identifying a concept"? [#what-identifying]
An identifier points to something, in this case to a concept. Identification is the process of clearly describing what the concept is and defining the term that points to it.

#### 2. Write the concept in a specific way: formulate criteria when you expect confusion to arise

##### why criteria? [#why-criteria]
Another person should be able to apply wording to a certain concept and then be able to independently decide whether something falls in or out of the criterium. Example: if a stool is defined with the criterium "all furniture to comfortably sit on with exactly 3 legs from seat to each non-fixed contact point of the leg on the floor", then anyone could (dis)qualify various instances of something to sit on that looks like a stool to many.
Although you might not fully agree that a 4-legged stool is no stool according to this definition with this criterium, the fact is that it's the generally applicable criterium that we were looking for.

###### Stools IN the criterium

![Stools](https://github.com/trustoverip/ctwg-terminology-governance-guide/blob/main/images/Stools.png?raw=true)

###### Stools OUTSIDE the criterium

![Not Stools](https://github.com/trustoverip/ctwg-terminology-governance-guide/blob/main/images/Non-stools.png?raw=true)

::: note Important consideration
Communication, understanding and learning will sky rocket with clear criteria, invest time in them and earn time back further down the road.
:::

Example: moving stools

If a group of people had to move every stool, but only stools, from a furniture warehouse into a large lorry without clear criteria what a stool is and isn't, you will end up leaving stools behind and for sure bringing back half a lorry of furniture upon unloading.

##### how to formulate criteria [#how-criteria]

In text. And you could add examples to a criterium of edge cases / corner cases: what falls just in the criterium and what is just outside?

##### what are good criteria? [#what-good-criteria]

Criteria that are determistic and clearly distinguish something.

#### 3. As long as a term is not understood by the target group: replace it with your criteria

```mermaid
flowchart TD
D{D:Text with criteria understood?}
D --> |3: No, I'll adjust criteria| D
```

##### why replace terms by criteria? [#why-replace]

Criteria can be independently applied, terms have a aledged meaning and interpretation might of terms might point to distinctive concepts.
Example: *move the stools into the van* might be interpreted as "break out the fixed stools in the cantina and bring the remnants to the van".

##### how to replace terms by criteria? [#how-replace]

Simply replace the term by the sentences criteria might consist of.

Example: *move the stools into the van* -> *move into the van all furniture to comfortably sit on with exactly 3 legs from seat to each non-fixed contact point of the leg on the floor*

#### 4. As soon as it’s understood: define the term with those criteria and replace the criteria in the text with the term.

```mermaid
flowchart TD
D{D:Text with criteria understood?};
E[E:Term definition incl. criteria]; F[/F:Text with terms/]
D --> |4: Yes, a term can be defined| E
E --> |4: Replace criteria by term | F
```

##### why put back terms [#why-back-terms]

Once you've succesfully identified a concept for all stakeholders, it makes no sense to maintain repetitions of lengthy criteria descriptions in a text. Maitenance of the criteria is also easier with a single point of defnition.

##### how to put back terms [#how-back-terms]

Be sure to create a Terminology definition with the criteria and identify this concept with the term intended.

For example:

[[def: stool, stools]]
~ furniture to comfortably sit on with exactly 3 legs from seat to each non-fixed contact point of the leg on the floor

AND then change the concept criteria in the text with the concept term:

move the [[ref: stools]] into the van.

##### Next time
You might come across a concept that has already been identified and defined with a term + criteria:

```mermaid
flowchart TD
A[A:I am writing, but I need to explain something! Help!];B{B:Terms understood?};C[/C:Glossary/]
A --> |1: Identify concepts| B
B --> |Yes, known term. Use ... | C
```
13 changes: 13 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,25 @@ module.exports = {
],
copyright: copyright.text.replace("[20XX-20YY]",`2022-${new Date().getFullYear()}`)
},
mermaid: {
theme: { light: 'neutral', dark: 'forest' },
options: {
//…
}
},
},

markdown: {
mermaid: true,
},
// themes: ['@docusaurus/theme-mermaid'],

presets: [
[
'@docusaurus/preset-classic',
{
docs: {
remarkPlugins: [require('remark-mermaid')],
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/tno-terminology-design/blob/master/',
showLastUpdateAuthor: true,
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@
"@docusaurus/preset-classic": "^2.4.1",
"@material-ui/core": "^4.11.0",
"classnames": "^2.2.6",
"docusaurus": "^1.14.7",
"mermaid": "^10.9.0",
"react": "^16.8.4",
"react-dom": "^16.8.4"
"react-dom": "^16.8.4",
"remark-mermaid": "^0.2.0"
},
"browserslist": {
"production": [
Expand Down
Loading