search

adlnet / xapi-profiles

A set of documents addressing the structure of and supporting services for xAPI Profiles.
https://adlnet.gov/projects/xapi/
Apache License 2.0
54 stars 27 forks source link

suggested new text for profile.definition and profile.seeAlso #144

Closed garemoko closed 7 years ago

garemoko commented 7 years ago

The profile definition property should be marked as optional, with a note that it must be included if no seeAlso is provided. Or if we want to keep it required, we should make clear that when a seeAlso URL is provided, the definition should be a shorter plain text summary.

For seeAlso...

Optional. A URL containing information about the profile. Recommended instead of especially long definitions.

Change to...

Optional. A URL containing human readable information about the profile. Recommended instead of especially long definitions, and for definitions including formatting.

fugu13 commented 7 years ago

I think we want at least a brief description of the profile in-document, but agreed on clarifying best practice alongside seeAlso