Data documentation – what and why
22/09/2016

Just as a map becomes much easier to read when you have a legend explaining the symbols, data is much easier to comprehend when you have descriptive and contextual information. For example, while you’re using your research data, you’ll know what your variable names are short for, and what different missing value codes mean. But if you want to reuse it in a few years’ time, will you still be certain? Or if another researcher uses your data, will they be able to understand it without needing to ask you questions? Maybe you’ve experienced frustration yourself, when you want to incorporate existing data into your research, but it wasn’t made available with sufficient information and you’ve had to spend time contacting the creator.
Making documentation available alongside your data is therefore a key step to ensuring its long-term usability and value, both for you and others (which might lead to extra citations). Documentation can be as simple as one text file, in which you’ve noted all the key contextual information about the data and the project. Some elements you might want to include are:
- Study-level information
- Data collection methods, such as instruments used, sampling methods, scales, geographic/temporal coverage, etc.
- Data processing methods, such as validation, checking, cleaning, calibration procedures, etc.
- Data-level information
- Names, labels, descriptions, and units for all variables and fields.
- Explanation of codes, including reasons for missing values (not applicable/not provided/not recorded/error/etc).
With data-level information, you may be able to include enough information in the data files themselves (e.g. in table headings in a spreadsheet). Otherwise, you might want to store a separate explanatory file alongside your data file(s). You could use our template readme.txt file to note all the necessary elements you want to include, perhaps adding to it as you work through the project.
Or you might benefit from writing what’s called a “data dictionary”, basically a legend to your data. This great blog post on data dictionaries explains it in a nutshell, and highlights the benefits, whether sharing data with others (in or outside your project team) or just your future self. And remember that if you’ve entered this information into a tool such as SPSS, you should be able to export it to a file to store with your data (e.g. in SPSS v23, File > Display Data File Information > Working File > print, and print to pdf, or use the File > Export option in many screens to export to a more usable format such as txt).
So, when depositing your data in a repository, remember to include sufficient documentation for others (or your future self!) to understand it so no questions arise.
Image: City map by Mathieu Pellerin, CC-BY-NC-SA 2.0.
Categories & Tags:
Leave a comment on this post:
You might also like…
Finding full-text Economist articles…
If you’re looking for The Economist, the place to go is ProQuest One Business. Follow these step-by-step instructions to get full-text access. Login here and click on the Publications option at the top, above the ...
Changes to Library Services over Easter, 18-21 April
Libraries on the Cranfield site Both Kings Norton Library and the School of Management Library (Building 111, first floor) will be open 24/7 over the Easter weekend. You will be able to use the study ...
Searching Statista: Effective strategies and Research AI tips
Statista is a global data and business intelligence platform with an extensive collection of statistics, reports, and insights on over 80,000 topics from 22,500 sources in 170 industries. It offers data on the global digital ...
Introducing…. BankFocus (Orbis)
For anyone researching the financial sector, BankFocus is a great place to start, providing financial and company data for finance institutions and companies from across the world. The service allows you to search for a ...
The Implications of US Tariffs on global supply chains
US President Donald Trump's new tariff policies announced on April 2, 2025 are expected to cause significant disruptions to the global supply chains, affecting multiple sectors and countries. A simple mathematical equation uses a country’s ...
Mastering the art of revising your writing
You’ve done the research and written your first draft. Now it’s time for one of the most crucial jobs as a writer - revising your writing to ensure your reader does not have to work ...