Skip to content

📝 Metadata and Documenting Data in Zenodo

Overview

This is the Metadata and Documenting Data in Zenodo page, part of Other Tools → Zenodo in the A-LIFE RDM collection.

Before publishing in Zenodo, good documentation makes your dataset findable, citable, and reusable. This page covers:

Supporting materials: Best Practices — Filling in the Metadata Form, Essentials — README
Authors: Irene Martorelli, Brett Olivier — Last modification: 2026-08-02 — Version: 0.2.0

ℹ Metadata and README

A well-documented Zenodo package has two complementary layers:

  • Metadata — structured fields (title, creators, description, licence, resource type, etc.) that you fill in directly in the Zenodo interface when creating a record. Metadata is machine-readable, feeds search engines and data catalogues, and makes your dataset findable and citable. Some fields are mandatory; others are strongly recommended.
  • README — a plain text file that you write and include inside your uploaded files (or ZIP archive). It is human-readable and describes the content of the files, how the data was collected, and how to use it. The README is not enforced by Zenodo, but it is strongly recommended and required by the A-LIFE checklist before archiving.

Metadata answers "what is this dataset?" for search engines and catalogues. The README answers "what is in these files?" for the person who downloads them.

🏷 Completing the Metadata Form

When you create a new upload in Zenodo, you fill in a metadata form as part of the archiving process. The form includes three categories of fields: Basic (mandatory), Recommended, and Other (optional).

Key things to prepare in advance:

  • Title — a clear, descriptive title for the dataset (not just "data")
  • Creators — names, affiliations, and ORCID identifiers for all contributors
  • Description — a concise summary of what the dataset contains and what research it supports; you can copy the key content from your README
  • Resource type — choose the type that best fits (dataset, software, poster, etc.)
  • Licence — decide which licence applies to your data before uploading; check with your data steward if unsure
  • Related publications — link your dataset to any associated article using its DOI

For step-by-step guidance on every field in the Zenodo metadata form, follow our dedicated best practice guide:

Best Practices — Completing the Zenodo Metadata Form

📄 Documenting your data

We explicitly recommend including a README file in your Zenodo package before submitting for publication. A README is a plain text file (.md or .txt) that describes the content of your dataset. Include it inside your ZIP archive or upload it as a separate file alongside your data files.

What to include in your README

A good Zenodo README should cover:

  • A short description of the dataset and what research question or publication it supports
  • A list of the files or folders included, with a brief description of each
  • Information about how the data was collected, generated, or processed
  • Software, tools, or dependencies needed to open or work with the files
  • Licence information
  • Contact details

Tip

Copy the key description from your README into the Zenodo Description field when filling in the metadata form — this ensures the content is visible on the dataset landing page without requiring a download.

README template and tips

👉 See the README section in our GEMs for a ready-to-use template and examples.

✨ Get inspired by your A-LIFE colleagues!

Not sure where to start? A great way to get inspired is to look at what your A-LIFE colleagues have done! The datasets below are published by A-LIFE researchers and archived in Zenodo — each includes a README you can browse directly on the record page. Take a look at how they described their files and structured their documentation. Every research domain is different, so feel free to adapt what you see to your own workflow.

Model output and scripts for QUINCY-JSM simulations for Amazonian forest sites — Fleischer, Katrin et al. (2026) · DOI · View README

Data and code for "Predicting the functional impact of single nucleotide variants in Drosophila melanogaster with FlyCADD" — Beets, Julia et al. (2025) · DOI · View README

What next?

Metadata prepared and README ready? Continue to Publishing in Zenodo to publish.