Structured Context for HfLA created data sets

ExperimentsInHonesty commented 2 years ago

Overview

We need to have minimum standards for structured context in data sets we create and or deploy in our projects so that we can help consumers understand the context from which they come.

Action Items

[ ] Identify existing resources for structured context, adding each example as a link in the resources section
- [ ] Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
[ ] Create a draft template, in all the formats the data will come in (json, csv, etc.) and upload to repo as a pr in the folder structured-context
- [ ] Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
[ ] Discuss plan with data science team
[ ] Create a guide on how to use the template
- [ ] Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
[ ] Review the guide with product management communities of practice
- [ ] Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
[ ] Present to Hack for LA leadership team for sign off
- [ ] Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
[ ] Possibly create an issue template on .github
- [ ] Include link to template under resources if you add it as a template in .github

Resources

Refer to https://github.com/hackforla/product-management/issues/123 for how to write a guide and the guide template

Resources/Instructions

Datasheets for Data Sets Definition of data context Article on data in context Adding context to data visualizations Civic Data Library Civic Software Foundation

akhaleghi commented 2 years ago

Added three resources (some may be more relevant than others). I didn't come across the term "structured context" much in looking for resources online.

ExperimentsInHonesty commented 2 years ago

@akhaleghi how is this a guide issue. Please add to our agenda for discussion.

ExperimentsInHonesty commented 2 years ago

added this issue to the agenda for DS pm meeting https://github.com/hackforla/data-science/issues/65#issuecomment-998129637 - revisit on 2022-01-03

ExperimentsInHonesty commented 2 years ago

We didn't meet, we will pick this up at this week's meeting 2022-01-07

hackforla / data-science