Skip to content

Commit 2d44a9d

Browse files
committed
Update README
1 parent 4fa2865 commit 2d44a9d

File tree

1 file changed

+58
-35
lines changed

1 file changed

+58
-35
lines changed

README.md

Lines changed: 58 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -40,51 +40,87 @@ For consistency, the term “Policy” in a type name should only be used singul
4040

4141
### Alternative names
4242

43-
Some terms types might have several commonly-used names, often varying by jurisdiction. To increase discoverability and clarity, alternative names can be provided to terms types. These alternative names are not translations, but rather synonyms in English. They are provided in an array under the `also known as` key.
43+
Some terms types might have several commonly-used names, often varying by jurisdiction. To increase discoverability and clarity, alternative names can be provided to terms types. These alternative names are not translations, but rather synonyms in English. They are provided in an array under the `aliases` key.
4444

4545
Examples:
4646

47-
- `"Hyperlinks Policy" : { "also known as": [ "Links Policy", "Linking Policy" ], … }`
48-
- `"Whistleblower Policy": { "also known as": [ "Whistleblower Protections" ], … }`
47+
- `"Hyperlinks Policy" : { "aliases": [ "Links Policy", "Linking Policy" ], … }`
48+
- `"Whistleblower Policy": { "aliases": [ "Whistleblower Protections" ], … }`
4949

50-
### Triptych
50+
### Required attributes
5151

52-
In order to guide usage and disambiguate synonyms, each terms type is characterised by a triptych along the three dimensions of the `commitment` that is being taken in it:
52+
Each terms type is characterized by two required attributes:
5353

54-
- the `writer` of the document, in most cases the service provider itself;
55-
- the targeted `audience` whose rights and duties are defined in the associated terms;
56-
- the `object` of the commitment, i.e. the information or interaction whose handling will be constrained by the associated terms.
54+
- the `topic` of the commitment, i.e. the information or interaction whose handling will be constrained by the associated terms;
55+
- the targeted `obligee` whose rights and duties are defined in the associated terms.
5756

58-
Each type thus has the following structure, where all fields are required:
57+
Each type thus has the following structure:
5958

6059
```json
6160
{
6261
"<Terms Type Name>": {
63-
"commitment": {
64-
"writer": "<writer>",
65-
"audience": "<audience>",
66-
"object": "<object>"
67-
}
62+
"topic": "<topic>",
63+
"obligee": "<obligee>"
64+
}
65+
}
66+
```
67+
68+
### Optional attributes
69+
70+
Terms types can have additional optional attributes:
71+
72+
#### Industries
73+
74+
Some terms types might be specific to certain industries. These can be specified in an array under the `industries` key.
75+
76+
```json
77+
{
78+
"<Terms Type Name>": {
79+
"topic": "",
80+
"obligee": "",
81+
"industries": [
82+
"Air Transport",
83+
"Maritime Transport"
84+
]
85+
}
86+
}
87+
```
88+
89+
#### Jurisdictions
90+
91+
Some terms types might be specific to certain jurisdictions. These can be specified as [ISO 3166-2 region codes](https://en.wikipedia.org/wiki/ISO_3166-2) in an array under the `jurisdictions` key.
92+
93+
```json
94+
{
95+
"<Terms Type Name>": {
96+
"topic": "",
97+
"obligee": "",
98+
"jurisdictions": [
99+
"US",
100+
"GB",
101+
"FR"
102+
]
68103
}
69104
}
70105
```
71106

72-
### References
107+
#### References
73108

74-
It may also contain an optional `references` property which contains a map of related resources that may help to understand the purpose of this type, such as legal definitions, or the discussions that led to the choice of this name. Each reference must have a name and a URL.
109+
Terms types may contain a `references` property which contains a map of related resources that may help to understand the purpose of this type, such as legal definitions, or the discussions that led to the choice of this name. Each reference must have a name and a URL.
75110

76111
```json
77112
{
78113
"<Terms Type Name>": {
79-
"commitment": { },
114+
"topic": "",
115+
"obligee": "",
80116
"references": {
81117
"<reference name>": "<URL where the reference can be found>"
82118
}
83-
},
119+
}
84120
}
85121
```
86122

87-
#### Legal references
123+
##### Legal references
88124

89125
Legal references will be prefixed by the flag emoji of the jurisdiction of enactment, will use the full name of the law, and will link to the official journal URL.
90126

@@ -97,14 +133,11 @@ Examples:
97133

98134
```json
99135
"Whistleblower Policy": {
100-
"also known as": [
136+
"topic": "reporting on suspected misconduct and illegal acts and prevention of retaliation",
137+
"obligee": "employees",
138+
"aliases": [
101139
"Whistleblower Protections"
102140
],
103-
"commitment": {
104-
"writer": "service provider",
105-
"audience": "employees",
106-
"object": "reporting on suspected misconduct and illegal acts and prevention of retaliation"
107-
},
108141
"references": {
109142
"Open Terms Archive discussion": "https://github.com/OpenTermsArchive/terms-types/discussions/37",
110143
"🇺🇸 Whistleblower Protection Act of 1989": "https://www.govinfo.gov/content/pkg/STATUTE-103/pdf/STATUTE-103-Pg16.pdf",
@@ -113,16 +146,6 @@ Examples:
113146
}
114147
```
115148

116-
## How to define the triptych
117-
118-
To identify the triptych of specific terms, answer the following questions:
119-
120-
1. Who is responsible for creating and maintaining those terms? Most often, it will be the `service provider` itself. Sometimes, while still being the service provider, it could be that only providers from a certain industry could write such terms, such as `transportation operator`.
121-
2. Who is the target audience whose rights and duties are defined? Often, it will be the `end user`, but it can also be the `commercial partners` or `business users`, for example.
122-
3. Which information or interaction precisely is constrained by those terms? For example, the `end users’ personal data`, or maybe the `privileged seller status programme`. Try to be as specific as possible, as this precision enables distinguishing between otherwise similar types.
123-
124-
After having answered these questions, if reading out loud the triptych, it sounds right to say that **“these terms describe how the `<writer>` commits to handle the `<object>` for its `<audience>`**.
125-
126149
## Add new terms types
127150

128151
Contributions to expand the list of known terms types are welcome, but need to follow a strict design, review and validation process in order to ensure consistency in the ontology. If you'd like to suggest a new type, please follow the process detailed in the [CONTRIBUTING file](CONTRIBUTING.md#add-new-terms-types).

0 commit comments

Comments
 (0)