Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create data dictionary documentation #169

Closed
3 tasks done
ryanmswan opened this issue Jan 15, 2020 · 4 comments
Closed
3 tasks done

Create data dictionary documentation #169

ryanmswan opened this issue Jan 15, 2020 · 4 comments
Assignees
Labels
Feature: Documentation Improvements or additions to documentation Role: Data Science Data management, loading, or analysis v1 The first version of the site

Comments

@ryanmswan
Copy link
Contributor

ryanmswan commented Jan 15, 2020

Overview

Create a spreadsheet document cataloguing data fields in the 311-data

Action Items

  • Create Google Doc and link from Wiki
  • Look over all Socrata data stores and document these fields' data type, value range, and consistency

Resources/Instructions

https://www.bridging-the-gap.com/data-dictionary/
https://medium.com/@leapingllamas/data-dictionary-a-how-to-and-best-practices-a09a685dcd61

Future Directions

  • Collaborate with front-end developers and data cleaning team to identify which new fields are being created for analysis and document their location and characteristics similarly to the Socrata data
@ryanmswan ryanmswan added Feature: Documentation Improvements or additions to documentation Role: Data Science Data management, loading, or analysis labels Jan 15, 2020
@ryanmswan
Copy link
Contributor Author

Work in progress document available at: LINK

@ExperimentsInHonesty
Copy link
Member

@ryanmswan can you provide an update

  1. Progress - I see the link, but unclear what percentage done, etc.
  2. Blocks - are there any
  3. Availability to work on this
  4. ETA to completiong

@ryanmswan
Copy link
Contributor Author

  1. Currently about 50% done. This is dependent on Convert analysis script to SQL queries #213 and Issue #170 - Created Markdown File and Started List. #230
  2. Next step is updating with cleaned data information (additional columns). Final update will be with front-end-facing data structures.
  3. Can update periodically as we continue updating data structures.
  4. Dependent on other issues, but should be resolved by end of February.

@ryanmswan
Copy link
Contributor Author

@github-project-automation github-project-automation bot moved this to Done (without merge) in P: 311: Project Board Aug 22, 2024
@ExperimentsInHonesty ExperimentsInHonesty added the v1 The first version of the site label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Documentation Improvements or additions to documentation Role: Data Science Data management, loading, or analysis v1 The first version of the site
Projects
Status: Done (without merge)
Development

No branches or pull requests

3 participants