Skip to content

Commit

Permalink
warning notice for content vs. terminology editting
Browse files Browse the repository at this point in the history
Signed-off-by: henkvancann <[email protected]>
  • Loading branch information
henkvancann committed Jun 24, 2024
1 parent f767901 commit a338f4e
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions spec/36_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,25 @@ A clear specification of roles in- and outside an average ToIP "group" might cle
### Role: ToIP glossary maintainer
Uses: Source management tool. Reads and compares concepts in text and terminology in glossaries, (for example generated by Spec-Up) to use within his/hers "own" over-arching ToIP glossary. He/she builds as much consensus around terms and concepts and promotes using the ToIP glossary as reference material.

### Role: Specification content author, describing concepts
Focusses on content of definitions covering concepts of the group he/she belongs to. Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions.
### Role: Specification CONTENT author, describing concepts
Focusses on content and concepts of the group he/she belongs to.

::: warning Warning Notice
Whenever he/she changes **terminology** he should be aware that it's within the responsibility of the *terminology author* to make changes to defs and refs!
:::

Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions.


### Role: Specification TERMINOLOGY author, covering concepts
Focusses on term definitions covering concepts of the group he/she belongs to.

::: note Notice
He/she maintains a consistent set of definitions and references throughout the specification.
:::

Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions. Specification author terms that cover those concepts.

### Role: Specification terminology author, covering concepts
Focusses on term definitions covering concepts of the group he/she belongs to. Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions. Specification author terms that cover those concepts.

### Role: Curator
Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context and uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors.
Expand Down

0 comments on commit a338f4e

Please sign in to comment.