Module 3.4: Data Documentation for Open Civic Data

Introduction

This is the second of two modules on metadata and documentation. In this module, we consider the ways that open data initiatives have approached creating and managing the information about data, or metadata. We will build an understanding of the importance of data documentation for supporting understanding and reuse of civic open data.

Guiding Questions

• What is metadata and data documentation and why are they important to open civic data sharing?

• How does data documentation impact the interpretation of data?

• How can information professionals create data documentation that makes open civic data easier to use and understand?

Vignette

To support the usage of their Wi-Fi data, the librarian creates metadata for the dataset shared through the open data portal and creates a data dictionary and readme file that supports the reuse of the data. They also create a civic data guide, based on the LibGuide model, that provides information about why and how the data was collected, the organizational context in which it was collected, and the limitations of the data. The librarian also seeks out qualitative stories to contextualize the data to include in this guide.

Instructional Materials

Video

Module 3.4 Captioned Video: Data Documentation for Open Civic Data

Video Files

41MB

Module3.4_CaptionedRecording.mp4

Open

Module 3.4 Captioned Video: Data Documentation for Open Civic Data MP4 File

36MB

Module3.4_UncaptionedRecording.mp4

Open

Module 3.4 Uncaptioned Video: Data Documentation for Open Civic Data MP4 File

Script and Slide Deck

Module 3.4 Script Preview

Module 3.4 Slide Deck Preview

Script and Slide Deck Files

360KB

Module3.4_Script.docx

Open

Module 3.4 Script: Data Documentation for Open Civic Data Word Document File

103KB

Module3.4_Script.pdf

PDF

Open

Module 3.4 Script: Data Documentation for Open Civic Data PDF File

3MB

Module3.4_Slides.pptx

Open

Module 3.4 Slides: Data Documentation for Open Civic Data PowerPoint Fiile

1MB

Module3.4_Slides.pdf

PDF

Open

Module 3.4 Slides: Data Documentation for Open Civic Data PDF Fiile

Activities

There are two activities that support modules 3.3 and 3.4. We recommend engaging with both modules before completing the activities.

Activities for Modules 3.3 and 3.4 are available on their own sub-page: Modules 3.3 & 3.4 Activities

Resources

http://www.wprdc.org/data-user-guides/www.wprdc.org

Data user guides are an expansion of data documentation, providing users with an understanding of the context for data creation and examples of the data in use. The Western Pennsylvania Regional Data Center offers example data guides that they have created for open civic datasets and a template that can guide creation of this documentation. Citation: Western Pennsylvania Regional Data Center. "Data User Guides." http://www.wprdc.org/data-user-guides/