hackforla / hackforla/knowledgebase-content

Structured Context for HfLA created data sets

Aperta
#159 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Complexity: Missing CoP: Data Science milestone: missing
Lingua principale
Nessun dato sulla lingua
Stelle
2
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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/knowledgebase-content/issues/106 for how to write a guide and the guide template

### Resources/Instructions
[Datasheets for Data Sets](https://arxiv.org/pdf/1803.09010.pdf)
Definition of [data context](https://simplicable.com/new/data-context)
Article on [data in context](https://www.idashboards.com/blog/2018/05/02/data-in-context/)
Adding context to [data visualizations](https://www.yellowfinbi.com/blog/2017/03/spoonful-of-context-helps-data-visualization-go-down)
[Civic Data Library](https://www.civicdatalibrary.org)
[Civic Software Foundation](https://www.civicdatalibrary.org)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by reviewing the linked resources and knowledgebase-content issue 106 for the guide format. Then inspect the repository's structured-context folder and .github conventions before drafting templates in the data formats named by the issue. Done requires the resources, draft templates, usage guide, reviews, leadership sign-off, and any issue-template decision to be completed.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
data, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.