Skip to content

Commit

Permalink
added an audience section
Browse files Browse the repository at this point in the history
Signed-off-by: henkvancann <[email protected]>
  • Loading branch information
henkvancann committed Aug 30, 2024
1 parent 142e926 commit 591e80c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
23 changes: 23 additions & 0 deletions spec/64_audience.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Audiences and languages

We have audiences that need to be addressed in their own language in along three axes:
1. Level of Understanding: we currently use three levels of understanding
2. Languages: e.g. Switzerland has four languages
3. Jargon: language specific for field of expertise

### Design principle
We stick to one language in the most specific (or most elaborate definition of a term) for the source.

Jargon needs a separate term definition to specify the term that covers a know concept for an inner circle but is unknown to the outside world.

We use AI tools to translate to more general language for a lower level of understanding in the line of work or the mental model.

We use AI tools to translate to a different language from the source language. E.g. English -> German & French & Italian. Why?: because it's a lot of work to maintain terms definitions in four languages by hand and have every single term definition still cover the same concept.

We always generate a link to the original, most elaborate, source in the base language. Why?: to back your AI-generated translations with the human-curated source.

[//]: # (Pandoc Formatting Macros)

[//]: # (\newpage)

[//]: # (\makebibliography)
6 changes: 0 additions & 6 deletions spec/64_biblio.md

This file was deleted.

2 changes: 1 addition & 1 deletion specs.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"specs":[{"title":"ToIP Template Specification","spec_directory":"./spec","output_path":"./docs","markdown_paths":["05_title.md","10_header.md","13_toc.md","16_foreword.md","18_clauses.md","20_introduction.md","24_scope.md","28_design.md","32_howto_define.md","36_roles.md","40_tools_landscape.md","44_style_guide.md","48_source_management.md","52_manual_defsrefs.md","glossary-intro-created-by-split-tool.md","terms-definitions/guide.md","terms-definitions/normative.md","terms-definitions/phrase.md","terms-definitions/term.md","terms-definitions/abbrev.md","terms-definitions/alias.md","terms-definitions/doctag.md","64_biblio.md","68_spec-up-improvements.md","72_integration.md","90_annex.md"],"logo":"https://raw.githubusercontent.com/trustoverip/logo-assets/master/logos/ToIP-Logo-Color-SolidDimensional-Horizontal-LightOnDark.svg","logo_link":"https://github.com/trustoverip/specification-template","katex":true,"source":{"host":"github","account":"trustoverip","repo":"specification-template"}}]}
{"specs":[{"title":"ToIP Template Specification","spec_directory":"./spec","output_path":"./docs","markdown_paths":["05_title.md","10_header.md","13_toc.md","16_foreword.md","18_clauses.md","20_introduction.md","24_scope.md","28_design.md","32_howto_define.md","36_roles.md","40_tools_landscape.md","44_style_guide.md","48_source_management.md","52_manual_defsrefs.md","glossary-intro-created-by-split-tool.md","terms-definitions/guide.md","terms-definitions/normative.md","terms-definitions/phrase.md","terms-definitions/term.md","terms-definitions/abbrev.md","terms-definitions/alias.md","terms-definitions/doctag.md","64_audience.md","68_spec-up-improvements.md","72_integration.md","90_annex.md"],"logo":"https://raw.githubusercontent.com/trustoverip/logo-assets/master/logos/ToIP-Logo-Color-SolidDimensional-Horizontal-LightOnDark.svg","logo_link":"https://github.com/trustoverip/specification-template","katex":true,"source":{"host":"github","account":"trustoverip","repo":"specification-template"}}]}

0 comments on commit 591e80c

Please sign in to comment.