Skip to main content
U.S. flag

An official website of the United States government

October 5, 2023

Data and software may be publicly available but if they are not well-documented, then they are not completely accessible to all.

Documentation in the form of machine-readable metadata and readme files are crucial for any use or reuse of data and software. It is incredibly hard to responsibly re-use or interpret data or software without robust documentation explaining who, what, where, when, why, and how.  

Have you ever returned to your data or software after a two-week vacation and thought, “what is this?” or “why did I do it that way?” Now, imagine that you have never seen the data or software before. What information would you need to know to understand and use them? That is the type of information that you need to include in your documentation. 

Action: Learn more about creating metadata for data and software.  

Get Our News

These items are in the RSS feed format (Really Simple Syndication) based on categories such as topics, locations, and more. You can install and RSS reader browser extension, software, or use a third-party service to receive immediate news updates depending on the feed that you have added. If you click the feed links below, they may look strange because they are simply XML code. An RSS reader can easily read this code and push out a notification to you when something new is posted to our site.

Was this page helpful?