hackforla / hackforla/knowledgebase-content

Structured Context for HfLA created data sets

Abierto
#159 7 comentarios 0 reacciones 0 asignados Ver en GitHub
Complexity: Missing CoP: Data Science milestone: missing
Lenguaje dominante
Sin datos de lenguaje
Estrellas
2
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

### 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)

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza revisando los recursos enlazados y knowledgebase-content issue 106 para conocer el formato de la guía. Después, inspecciona la carpeta structured-context del repositorio y las convenciones de .github antes de redactar plantillas en los formatos de datos indicados por el issue. Se considerará completado cuando se hayan completado los recursos, las plantillas preliminares, la guía de uso, las revisiones, la aprobación del liderazgo y cualquier decisión sobre las plantillas de issue.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
data, documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.