Improve long descriptions

[jo-schroeder]

Current guidance: "Long account of the production of the measure (no character limit). Should include detail on methods, multiple data sources, the way things were combined, decisions made to create the measure."

• [x] Turn this guidance into a short checklist
• [x] Improve checklist by referencing standards, best practices
• [x] Evaluate long_descriptions in a repository (start with sdc.broadband) against the checklist

Standards

• Cornell README guide

Best practice examples

• Opportunity Atlas
• Feeding America Map the Meal Gap

[tdcham]

Standard Checklist Created:

Measure Description:

• Defines the measure
• Explains why it’s used
• Is Readable by a general audience

Data Sources

• Enumerate each source
• Validate the relevance of each source

Methods

• Detail techniques, formulas and procedures used (e.g. equations, algorithms, link to tech reports explaining methods etc.)
• Ensure reproducibility, clarity, and readability by a general technical audience.
• Document key decisions and their motivations.

Peer Review

• Have a colleague review your long description.
• Revise if necessary

[tdcham]

Evaluate long_descriptions in a repository (start with sdc.broadband) against the checklist: https://myuva-my.sharepoint.com/:w:/r/personal/huz2ph_virginia_edu/Documents/Long_description%20standard%20checklist.docx?d=w41288635d11d448fa63a38e452cb8d13&csf=1&web=1&e=Gbfh01 (OLD LINK NEW is BELOW)

[tdcham]

I updated the checklist within another Word document based on the comments I saw. Let me know about some other suggestions you'd like to make; I really appreciate the feedback! Link: https://myuva-my.sharepoint.com/:w:/g/personal/huz2ph_virginia_edu/Ed58Vyv2ISJDvfRQA-jO1mUBtQ5Uz3YEUhKBTKGNVxOKiA?e=H5enx1

[jo-schroeder]

• Decide what parts of what parts of the checklist are "required" and "optional"
• Apply the checklist to the measures in business climate and education (keep track of what ticked off measure)
• Joanna will circulate to the full metadata team

[tdcham]

Made updates to the checklist to include examples as well as specify which parts of the checklist are "required" and "optional". The next steps are to evaluate the long descriptions in the Financial Well-Being section of the Virginia Department of Health Data Commons using a rubric-styled format. These evaluations will be shown in the checklist document itself. https://myuva-my.sharepoint.com/:w:/g/personal/huz2ph_virginia_edu/Ed58Vyv2ISJDvfRQA-jO1mUBtQ5Uz3YEUhKBTKGNVxOKiA?e=H5enx1