Skip to content

Commit

Permalink
example extended
Browse files Browse the repository at this point in the history
Signed-off-by: henkvancann <[email protected]>
  • Loading branch information
henkvancann committed Nov 3, 2024
1 parent c2cd83a commit 14cb359
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,26 @@ Contributing to any Spec-Up-T-based specification can be of type:
- `content author` or editor
- `terminology author` or editor

Any specifcation has a content part and a Terms and Definitions section. In real life they appear in the same document. There'll be one chapter called Terms and Definitions, into which Spec-Up-T generates all the term defnitions. All the other chapters (if present) are considered 'content'. For example the chapter "Autonomous Identifiers".
Any specifcation has a **content** part and a Terms and **Definitions** section. In real life they appear in the same document. There'll be one chapter called Terms and Definitions, into which Spec-Up-T generates all the term defnitions. All the other chapters (if present) are considered 'content'. For example the chapter "Autonomous Identifiers".
However, through all the chapter, including the Terms and Definitions chapter itself, references to the Terms & Definition may occur and literally pop-up.

> KERI inventor Sam Smith can be a reader of the spec, but will most probably quickly turn into a `curator`, `content author`, and `terminology author`.
> Henk van Cann has written 90% of all KERI definitions, he's a typical `terminology author`. Kent Bull has been a curator for quite a few definitions of Henk because of Kent's native tongue.
> Henk van Cann has written 90% of all KERI definitions, he's a typical `terminology author`. Kent Bull has been a curator for quite a few **definitions** of Henk because of Kent's native tongue and extensive KERI knowledge.
> Phil Pfeairheller is a typical user of term defnitions. Generally he is a `content author` of specifications in the KERI team, whenever he sees a term that is not yet defined, he might create a definition on-the-fly if needed.
Note that any specification could use only definitions of other glossaries. And x-ref to those glossaries. This is rather uncommon because if your specifying, you most probably construct new concepts whithin a new mental model.
Note that any specification could use only **definitions** of other glossaries. And xref to those glossaries. This is rather uncommon because if your specifying, you most probably construct new concepts whithin a new mental model.

So most probably per repo it will be a mixture of:
Drummond Reed is `terminology author` of the ToIP main glossary. The main glosary has *hardly any content section*. All other terminology authors and content authors can use the Main ToIP glossary by `xref`-ing to it, as a plain Spec-Up-T link "[[xref: glossary, term ]]" even in their own `def`s to explain the difference between the mental model of the term in the smaller context vs. the broader ToIP context.

So most probably per repo the term **definitions** will be a mixture of:
- full-URL links to external glossaries and resources
- `x-ref`s to other Spec-Up-T based glossaries
- `xref`s to other Spec-Up-T based glossaries
- `ref`s to `def`s present in the own Terms and Definition section
- the `def` section will contain `ref`s and `x-ref`s too to other terms
- the `def` section will contain `ref`s and `xref`s too to other terms

The more x-refs a specification and team is able to use the more consensus is build in the broader community. For example: Henk van Cann will sync all terms that the KERI team uses with the one that IoIP uses in the main ToIP glossary.
The more `xref`s a specification and team is able to use the more consensus is build in the broader community. For example: Henk van Cann will sync all terms that the KERI team uses with the one that IoIP uses in the main ToIP glossary.

### Formal roles and flow

Expand Down

0 comments on commit 14cb359

Please sign in to comment.