[Documentation] Documentation page for metadata completeness

[gtsueng]

Background: Metadata completeness badges and their display are in development and their display is being mocked up. It would make sense to link a metadata completeness badge to a page on the Discovery Portal which would provide additional context about the badge and how the metadata completeness scores are derived.

The ask:

• [x] @EmilyHaag Please generate a draft of what such a page might look like in google docs for us to circulate and collaboratively edit. We will eventually want this page available on the website itself.
• [x] Review and improve document internally within Scripps team.
• [x] Iterate with NIAID. NIAID team: Is there anything you would like clarified, or any changes you'd like made?
• [x] Once approved by the NIAID team, @candicecz will integrate it with the Discovery Portal/documentation

Materials

2023.01.05 edit: The draft is now available here: https://docs.google.com/document/d/11ZLyHEuZJpfj3D3kgTx8cuFqD2bWjx_sWy_kzd5yviQ/edit?usp=sharing

Related WBS task

https://github.com/NIAID-Data-Ecosystem/nde-roadmap/issues/23 https://github.com/NIAID-Data-Ecosystem/nde-roadmap/issues/37

[gtsueng]

@EmilyHaag has created the first draft and provided it to the Scripps team on 2023.01.02. We will review it internally before asking the NIAID team if the would like to review/provide feedback on it.

[gtsueng]

@hartwickma @sudvenk @rshabman @lisa-mml

We have drafted documentation for the Metadata Completeness badge and hope to move this documentation to staging (and eventually production) in two phases:

1. Phase 1: We are seeking approval to move the documentation text on just the metadata completeness badges to staging (and ultimately production). We would like to link this documentation when addressing NIAID's request for a News page update announcing the metadata completeness badges.
2. Phase 2: This is documentation that will cover the application of the metadata completeness score to the search rankings. In collaboration with the NIAID team, we will amend the documentation page with this content in the future when it becomes available.

[gtsueng]

Duplicate of https://github.com/NIAID-Data-Ecosystem/niaid-feedback/issues/111

[gtsueng]

We have improved the documentation to include additional details on the metadata fields considered for the metadata completeness badge. With the expectation that this is a potential item for discussion at the biweekly meeting dated 2024.04.16, we are reopening this issue.

Summary of issue: Based on feedback from the NIAID team, there must be an easy way for users to be able to interpret the metadata completeness badge. Currently, the site displays an alt-text legend, which is considered insufficient. An alt-text report card has been suggested for which the following drawbacks were discussed:

• Redundant: Absence/presence of many metadata elements are already indicated in the card view of a search results page
• Performance: Either additional data would need to be stored in order to enable such a card, or the calculations would need to be done on the fly. In either case, the performance could suffer
• Purpose: Aside from understanding the metadata, this report card may frustrate the user since many metadata elements are set by the repository, so their ability to improve the metadata is limited

The following compromise was suggested: Improve the documentation to contain the information desired from the 'report card' and link the badge to the documentation.

The Ask: Does the improved documentation work for the compromise solution? Does it address the needs intended by the 'report card'?

[gtsueng]

Per discussion on 2024.04.23, the documentation improvements can move forward. Additionally, alternative solutions for conveying the missing fundamental and recommended fields were proposed (see https://github.com/NIAID-Data-Ecosystem/niaid-feedback/issues/115) for details

[gtsueng]

The changes have been updated to the Documentation page. We are marking this issue as pending close out and will close it after a week if there are no additional concerns regarding this issue