Research data documentation serves to describe your data and its generation and processing. It should be sufficiently detailed to enable anyone accessing your data to understand the process by which it was created, processed, cleaned, analysed, and interpreted, and to reproduce the results. The format of your research data documentation depends primarily on your discipline and the conventions in your research field. Where possible and common, you should use standardised data and controlled vocabularies to describe your data. In most cases, English is recommended as the documentation language.

For datasets uploaded to TU Wien Research Data, opens an external URL in a new window, TU Wien’s research data repository, we recommend the following measures to describe your data as thoroughly as possible: 

  • use the ‘Description’ field: a template is provided as a guideline
  • complete all metadata fields carefully and as completely as possible, and provide links to related publications, as well as to additional datasets, code, and infrastructure used
  • along with the data, upload README files containing detailed information on the nature and origin of the data, technical details, the structure of the data record, and the parameters, units, variables, codes, symbols, abbreviations, etc. used
  • it is also possible to upload additional documentation files such as data management plans, laboratory protocols, questionnaires, code books, or project reports
  • provide clear versioning information and a summary of changes with each new version of your dataset

Examples from TU Wien’s data repository

Pelletier, V.& Hladůvka, J. (2023). Eggshapes: A collection of egg-shaped objects and their boundaries (Version 1.0.0) [Dataset]. TU Wien. https://doi.org/10.48436/de66n-2pj41, opens an external URL in a new window

Cancellieri, M., El-Ebshihy, A., Fink, T., Gonzalez-Saez, G., Keller, J., Knoth, P., Piroi, F., Pride, D.& Schaer, P. (2025). LongEval 2025 CORE Retrieval Test Collection [Dataset]. TU Wien. https://doi.org/10.48436/v8phe-g8911, opens an external URL in a new window

Krasna, H. (2024). Global Reference Frame VLBI solution VIE2023 (SX&VG) (Version 1.0.0) [Dataset]. TU Wien. https://doi.org/10.48436/76404-a3492, opens an external URL in a new window

Preimesberger, W., Lems, J., Hirschi, M.& Dorigo, W. A. (2026). C3S SM PASSIVE Daily Gap-filled Root-Zone Soil Moisture from merged multi-satellite observations (Version v2) [Dataset]. TU Wien. https://doi.org/10.48436/9j8ad-z2q11, opens an external URL in a new window

Bauer-Marschallinger, B., Cao, S., Navacchi, C., Freeman, V., Reuß, F., Geudtner, D., Rommen, B., Vega, F. C., Snoeij, P., Attema, E., Reimer, C.& Wagner, W. (2022). The Sentinel-1 Global Backscatter Model (S1GBM) - Polar Extension (Version 1.0) [Dataset]. TU Wien. https://doi.org/10.48436/r9fn3-nyd51, opens an external URL in a new window

Kerschbaum, J. (2025). Survey of Green Platform Chemicals - Data surveyed via ECHA [Dataset]. TU Wien. https://doi.org/10.48436/gvfaj-r4965, opens an external URL in a new window

Ehrmann, K., Göschl, M., Laa, D.& Koch, T. (2025). Research Data for "Two for one: Semi-crystalline and amorphous multi-material structures from greyscale printing" [Dataset]. TU Wien. https://doi.org/10.48436/hpa43-sqq64, opens an external URL in a new window

FAQ

The documentation helps all project participants, the funder, interested research communities, and reusing parties. Documentation facilitates the correct classification of the contents and understanding of the research work. In addition, documentation is useful to you because it helps you keep track of your data and clearly structure your activities.

A rough structure of your documentation should be available before data collection, and it should be refined as the project progresses. By the time the project is completed, the documentation should also be complete so that the details of data collection and processing are not forgotten. In this way, you can minimise the effort required to create the documentation and avoid delays in publishing the data.

Regardless of whether README files, data dictionaries, codebooks, electronic lab notebooks or a combination of all: the essential information about your data must be clearly documented and available together with the data.

The content of the documentation also varies depending on the type of project and discipline. Key elements include:

  • description of the context and the conditions of the experiments
  • description of the method used to collect and process the data, including the tools used (equipment and software)
  • contents of test protocols, field reports, laboratory books
  • device-specific information required for an interpretation of the data
  • description of the quality assurance measures and procedures carried out
  • information on technical standards and calibrations
  • documentation and explanation of the parameters, variables, abbreviations and codes, including column headings in data tables
  • specification of data source when using existing data (references, DOI)
  • documentation of people involved and their tasks
  • documentation of the framework conditions for the long-term storage and subsequent use of data (licenses, usage restrictions, embargo periods, deletion rules)
  • a list of all associated files and folders, plus a description of their formats and contents
  • links to publications in which the data is used or quoted
  • links to related or related documents and datasets
  • links to all publicly accessible data storage locations
  • recommended citation of the data

The term electronic lab notebooks (ELN) refers to software that helps researchers document experiments and also serves as a collaboration tool and for managing laboratory inventory. The software helps simplify the laboratory workflow digitally.

For example, an electronic lab notebook can be used instead of a paper lab book or journal to document experiments and investigations. It is considered a legal document, just like the classic paper laboratory book, in patent proceedings or legal disputes over intellectual property.

With the help of an electronic lab notebook, you can organise and store your experimental procedures, notes and protocols. One advantage of this type of data documentation is that metadata is automatically created in the software.

Further advantages of the ELN software:

  • use on PCs, tablets, and mobile phones
  • multiple users and collaborative work are possible
  • direct transfer of data from analysis devices
  • data integrity secured, verifiability by time stamp
  • increased security through access controls
  • easy saving, copying, importing, exporting and linking of data
  • connection to other systems (API)
  • full text search in all contents
  • management of the laboratory inventory

A good overview and help in selecting a suitable ELN tool is provided by the ELN Finder of the ULB Darmstadt, opens an external URL in a new window.