# 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

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2FrA0YIamoqedFGtXs1CNx%2FModule%203.4%20Recording%20with%20Captions.mp4?alt=media&token=3c5d8d67-e123-40d2-9c99-991024d54b34>" %}
**Module 3.4 Captioned Video:** *Data Documentation for Open Civic Data*
{% endembed %}

#### Video Files

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2FrA0YIamoqedFGtXs1CNx%2FModule%203.4%20Recording%20with%20Captions.mp4?alt=media&token=3c5d8d67-e123-40d2-9c99-991024d54b34>" %}
**Module 3.4 Captioned Video:** *Data Documentation for Open Civic Data*\
MP4 File
{% endfile %}

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2Fc0ICwM0u46Xai9dZvSGY%2FModule%203.4%20Recording%20without%20Captions.mp4?alt=media&token=47211c7a-a536-4956-9806-43dfe46cd2c7>" %}
**Module 3.4 Uncaptioned Video:** *Data Documentation for Open Civic Data*\
MP4 File
{% endfile %}

### Script and Slide Deck

{% tabs %}
{% tab title="Module 3.4 Script Preview" %}
{% embed url="<https://docs.google.com/document/d/1snCBTtblCQ3RBulAC9ibHljWO3FVCV2Q_juztdDtcVY/edit?usp=sharing>" %}
{% endtab %}

{% tab title="Module 3.4 Slide Deck Preview" %}
{% embed url="<https://docs.google.com/presentation/d/1qOPB3MLluivX5zwwo3kddprdtqiFpyu74rMVMhBNE8E/edit?usp=sharing>" %}
{% endtab %}
{% endtabs %}

#### Script and Slide Deck Files

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2FiNs1DrUYU8aPC6u5awmp%2FModule3.4_Script.docx?alt=media&token=9676af0e-3ce2-497e-822d-acddd4feffd4>" %}
**Module 3.4 Script:** *Data Documentation for Open Civic Data*\
Word Document File
{% endfile %}

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2FizJpuRqwGeNYPYYJKgb6%2FModule3.4_Script.pdf?alt=media&token=b9738fbc-56fa-4466-bf51-c550255bbe7b>" %}
**Module 3.4 Script:** *Data Documentation for Open Civic Data*\
PDF File
{% endfile %}

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2FSzg8hGtA33fJdG0SUSpx%2FModule3.4_Slides.pptx?alt=media&token=a061ba83-ecf1-404d-8b47-b7da923c22b3>" %}
**Module 3.4 Slides:** *Data Documentation for Open Civic Data*\
PowerPoint Fiile
{% endfile %}

{% file src="<https://2020766289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiHhyQLuCq600FlDt9jWx%2Fuploads%2F9kiRGsRIUSnDr9wJr3N8%2FModule3.4_Slides.pdf?alt=media&token=666e9bcb-2f4d-46d7-96a6-0f4e39d38403>" %}
**Module 3.4 Slides:** *Data Documentation for Open Civic Data*\
PDF Fiile
{% endfile %}

## 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-and-3.4-activities](https://civic-switchboard.gitbook.io/education-series/segment-3-preparing-libraries-for-sharing-their-data/module-3.4-data-documentation-for-open-civic-data/modules-3.3-and-3.4-activities "mention")&#x20;

## Resources

{% embed url="<http://www.wprdc.org/data-user-guides/>" %}
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/>
{% endembed %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://civic-switchboard.gitbook.io/education-series/segment-3-preparing-libraries-for-sharing-their-data/module-3.4-data-documentation-for-open-civic-data.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.