Skip to content

Commit

Permalink
Document terms type name
Browse files Browse the repository at this point in the history
  • Loading branch information
MattiSG committed Oct 24, 2023
1 parent 9c1b650 commit 962b9ac
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ The `termsTypes.json` JSON file is a map of [title cased](https://en.wikipedia.o

The types might not always match the exact name given by the service provider. For example, some providers might call their document “Terms and Conditions” or “Terms of Use” instead of “Terms of Service”. The terms type does not have to match the exact name, it only has to match the commitment that is taken.

### Name

The name of each type is written with title capitalisation (every noun is capitalised).

It should be the most commonly used and most internationally understandable for this type.

### Tryptich

In order to guide usage and disambiguate synonyms, each terms type is characterised by a tryptich along the three dimensions of the `commitment` that is being taken in it:
Expand All @@ -40,7 +46,7 @@ Each type thus has the following structure, where all fields are required:

```json
{
"<Terms Type>": {
"<Terms Type Name>": {
"commitment": {
"writer": "the `writer` of the document",
"audience": "the targeted `audience",
Expand All @@ -56,7 +62,7 @@ It may also contain an optional `references` property which contains a map of re

```json
{
"<Terms Type>": {
"<Terms Type Name>": {
"commitment": { },
"references": {
"<reference name>": "<URL where the reference can be found>"
Expand Down

0 comments on commit 962b9ac

Please sign in to comment.