Skip to content

Commit f0d5bda

Browse files
committed
Improve explanation of per feedback
1 parent 9cf3fa0 commit f0d5bda

1 file changed

Lines changed: 35 additions & 7 deletions

File tree

content/user-guide.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -399,10 +399,42 @@ refer to a consistent identity of an individual.
399399

400400
### Roles
401401

402-
The `Role` type property is used within the `author` property to define the
403-
participation of a `Person`.
402+
The `Role` type property is used within the `author` or `contributor`
403+
properties to further define the participation of a `Person`. The property is
404+
intended to clarify the functional area the individual with the free-form
405+
value of the `roleName` property.
404406

405-
This is distinct from the `contributor` and `maintainer` properties.
407+
An example author role:
408+
409+
```json
410+
"author": [
411+
...
412+
{
413+
"roleName": "User Experience Design",
414+
"schema:author": "https://github.com/octocat",
415+
"type": "Role"
416+
},
417+
...
418+
]
419+
```
420+
421+
Or a contributor:
422+
423+
```json
424+
"contributor": [
425+
...
426+
{
427+
"roleName": "Documentation",
428+
"schema:author": "https://github.com/octocat",
429+
"type": "Role"
430+
},
431+
...
432+
]
433+
```
434+
435+
This is distinct from the `maintainer` property, which should be defined
436+
independently as a top-level property of the document, containing at least
437+
one `Person`.
406438

407439
The `Role` must link to a `Person` previously defined in the top-level
408440
property. The example below demonstrates the `id` and `schema:author` values
@@ -416,17 +448,13 @@ providing this link.
416448
"givenName": "Ruthvik",
417449
"type": "Person"
418450
},
419-
420451
...
421-
422452
{
423453
"roleName": "Tech Lead",
424454
"schema:author": "https://github.com/ruthvikm",
425455
"type": "Role"
426456
},
427-
428457
...
429-
430458
]
431459

432460
```

0 commit comments

Comments
 (0)