<commit_before>---
layout: page
title: 'Metadata Standard'
file: metadata.md
---

**Status:** Unapproved draft  

**Next step:** Share with open data liaisons for early review and feedback  

#### Questions and feedback are encouraged! Please submit [here](https://github.com/cityofaustin/open-data-docs/milestones/Metadata%20Standard%20v1.0).

***

### About this document


This document explains how to use metadata to describe open data assets held by the City of Austin. By using a common and consistent metadata vocabulary across City departments, we can make it easier for people to discover and use City information. 

**When would someone use these metadata standards?**

* An open data liaison publishing a new resource to the City's open data portal
* A City web developer wanting to make a department's open data offerings more discoverable by search engines
* A member of the public looking for a dataset to use in a project

**What does the metadata standard contain?**

* A list of descriptors (metadata elements) that should be provided whenever a dataset is published on the open data portal
* Description of when to use the metadata elements
* Details about how to use each element correctly

#### Design principles

* Be interoperable with existing standards such as those developed by the Federal Government and popular web search engines
* Start small and increase the number of elements over time
* Develop openly and in close collaboration with end users

<!--#### Additional resources-->
<!--* Metadata FAQ (coming soon)-->
<!--* Open Data FAQ (coming soon)-->

***

# When to use these metadata elements:

#### Required
Use of the standard metadata elements is required when publishing any dataset to the open data portal. The metadata values should also be included in the open data inventory. 
> An open dataset is a table, map, or any other resource that is published to the open data portal.

#### Optional
Any time a public dataset is shared internally or publically, it is beneficial to include these metadata elements in a note or accessory file that accompanies the share. All City of Austin staff and partners are welcome to use this standard. 

# List of required elements:

Element name | Definition | Format/Example 
--- | --- | --- 
`Title` | Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery. | 
`Description` | Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest. | 
`Last Update` | Most recent date on which the dataset was changed, updated or modified. | 
`Department Budget Code`  | The code for the COA Department represented by the dataset, as listed by the Budget Office. (needs link to dataset) | 
`Publisher` | The publishing entity and optionally their parent organization(s). | 
`Tags` | Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users. | 


# List of optional elements: 

Element name | Definition | Format/Example 
--- | --- | --- 
`_` | | 
`_` | | 

(to be determined)


#### References
- [Project Open Data Schema 1.1](https://project-open-data.cio.gov/v1.1/schema/)
- [metadata element matrix](https://docs.google.com/spreadsheets/d/1aKp0ygULe6u6Dbrtj3ZOXn4rN3SV5hv-K5Ho4vlT3EE/edit?usp=sharing)<commit_msg>re-format element list<commit_after>---
layout: page
title: 'Metadata Standard'
file: metadata.md
---

**Status:** Unapproved draft  

**Next step:** Share with open data liaisons for early review and feedback  

#### Questions and feedback are encouraged! Please submit [here](https://github.com/cityofaustin/open-data-docs/milestones/Metadata%20Standard%20v1.0).

***

### About this document


This document explains how to use metadata to describe open data assets held by the City of Austin. By using a common and consistent metadata vocabulary across City departments, we can make it easier for people to discover and use City information. 

**When would someone use these metadata standards?**

* An open data liaison publishing a new resource to the City's open data portal
* A City web developer wanting to make a department's open data offerings more discoverable by search engines
* A member of the public looking for a dataset to use in a project

**What does the metadata standard contain?**

* A list of descriptors (metadata elements) that should be provided whenever a dataset is published on the open data portal
* Description of when to use the metadata elements
* Details about how to use each element correctly

#### Design principles

* Be interoperable with existing standards such as those developed by the Federal Government and popular web search engines
* Start small and increase the number of elements over time
* Develop openly and in close collaboration with end users

<!--#### Additional resources-->
<!--* Metadata FAQ (coming soon)-->
<!--* Open Data FAQ (coming soon)-->

***

# When to use these metadata elements:

#### Required
Use of the standard metadata elements is required when publishing any dataset to the open data portal. The metadata values should also be included in the open data inventory. 
> An open dataset is a table, map, or any other resource that is published to the open data portal.

#### Optional
Any time a public dataset is shared internally or publically, it is beneficial to include these metadata elements in a note or accessory file that accompanies the share. All City of Austin staff and partners are welcome to use this standard. 

# List of required elements:

***

`Title` </br>
Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.
***

`Description` <br/>
Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.
***

`Last Update` <br/>
Most recent date on which the dataset was changed, updated or modified.
***

`Department Budget Code` <br/>
The code for the COA Department represented by the dataset, as listed by the Budget Office. (needs link to dataset)
***

`Publisher` <br/>
The publishing entity and optionally their parent organization(s).
***

`Tags`<br/>
Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.

# List of optional elements: 

(to be determined)


#### References
- [Project Open Data Schema 1.1](https://project-open-data.cio.gov/v1.1/schema/)
- [metadata element matrix](https://docs.google.com/spreadsheets/d/1aKp0ygULe6u6Dbrtj3ZOXn4rN3SV5hv-K5Ho4vlT3EE/edit?usp=sharing)
{'fraction_non_alphanumeric': 0.07722065168873679, 'fraction_numerical': 0.006249070078857313, 'mean_word_length': 4.3690095846645365, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 17, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1241792', 'n_tokens_mistral': 1719, 'n_tokens_neox': 1634, 'n_words': 906}