Details
-
Task
-
Resolution: Done
-
Major
-
None
-
None
-
Sprint 1
-
3
Description
Issues
There are some small problems in many definitions and we clean these up.
- Definitions with line breaks
- Listing descriptor values - we are trying to avoid this
- Inconsistency in definitions within elements. For example, consider AcademicHonor:
AcademicHonor - 'Academic distinctions earned by or awarded to the student.
AcademicHonorCategory - 'A designation of the type of academic distinctions earned by or awarded to the student
HonorDescription 'A description of the type of academic distinctions earned by or awarded to the individual
The definitions switch between "student" and "individual" - one of these should be used consistently
- Inconsistency of references: in the case of AcademicHonor, there is no student reference on that entity, so the referent in the definitions should be to the "individual" (and not the student)
- Potentially inconsistent definitions. Consider AcademicHonor again:
HonorAwardDate - 'The date the honor was awarded or earned.
The date an honor is awarded and the date it is earned are potentially different. There is no reason to open up this ambiguity. The definition "The date the honor was awarded" is clearer.
- Potentially abmiguous semantics or poor definitions (see
DATASTD-1466for an example). Also consider AcademicHonor again
HonorAwardExpiresDate - 'Date on which the award expires.
Why is the definition now switched to "award"? The referent should be switched to "honor" (entity name) or "distinction" (entity definition)
Todo
- For definition with line break issues, fix and issue a PR.
- For other issues, document these in TechDocs for fixing.
Attachments
Issue Links
- relates to
-
DATASTD-1697 Documentation cleanup for shared Common elements in the model
- Closed