Here’s how you should structure your dataset documentation. You can include/exclude as many headings as you feel appropriate. However, including the **recommended headings are recommended.

Dataset Title

**recommended

Include a description title. This will be displayed on the main page and helps with the dataset search as well. So, a good balance between descriptive and short is recommended here.

Dataset Description

**recommended

This section should provide a brief overview of the dataset and the context in which it was collected. It should also describe if any preprocessing that has been done.

Dataset Details

**recommended

This part will give more information to the reader about what is in your data and how they can use it for their task.

Here you should include:

  1. A brief description of your dataset
  2. If in a spreadsheet like format, you can include the list of columns and column’s description
  3. if it’s a image dataset, you can include information like resolution, image naming conventions, folder information and etc.
  4. Any other information that is specific to the dataset like date range, location, region etc

File information:

Here you can include information like the file format, file size and how to load the file.

Usage:

Examples of use cases of the dataset

Creator / Citation