README template for experimental materials datasets
README template for documenting experimental materials datasets, including sample preparation, measurement method, instrument settings, raw and processed files, calibration notes, data quality and reuse information.
Resource type: Documentation template
Hosted / supported by: FAIR Data Competence Center for Digital Materials Research
Purpose
This template helps researchers document experimental materials datasets in a clear and reusable form. It is intended for datasets produced by laboratory measurements, core facilities, characterization instruments and experimental access services.
What it contains
The template includes sections for the research task, material or sample description, sample preparation, experimental method, instrument or equipment used, measurement conditions, raw data, processed data, calibration or reference information, data quality notes, authorship, licence, repository record and citation information.
How it is used
Researchers, facility staff and data stewards use this template when preparing experimental datasets for repository deposit, DOI assignment, citation and reuse. It helps users understand how the data were produced, which instrument and method were used, what files are included and what conditions are needed for correct interpretation.
Recommended use
Use this README template together with the experimental materials characterization profile, the metadata checklist and the FAIR checklist. The README should be prepared before repository deposit and should accompany raw data, processed data, measurement notes, calibration information and metadata records.
Services using this resource
FAIR packaging of experimental materials datasets
This service helps users prepare experimental materials datasets for publication, citation and reuse. It focuses on structuring raw and processed experimental data, documenting methods and instruments, preparing README …
Repository deposit support
This service supports users in preparing and submitting repository-ready datasets for publication, citation and long-term preservation through DataverseUA or another suitable trusted repository.
README and DMP support for RI users
This service helps RI users prepare README files and data management plan documentation for computational, experimental and mixed materials science datasets.