Introducing and Defining Data Manuals

It is common for researchers and data management teams to have multiple data files associated with multiple codebooks and data dictionaries under a single study. For this reason, we are introducing the term “Data Manual”. A Data Manual includes the codebooks for each substantive topic, the data dictionaries for each data file, and then study meta- and para-data. In addition to the data dictionary and codebooks, data manuals should include descriptions of survey timings, intervention triggering, data use agreements, regulatory information, as well as preregistration and IRB information. In the same way that a researcher should be able to take a relatively unstructured datafile and a corresponding data dictionary and create a meaningful database, a complete data manual should allow anyone to completely replicate every aspect of a study. A Data Manual includes:

A Data Manual includes:

  • Survey Flowchart
    • A visual depiction of the survey/study flow, including branching and skip logic
  • Survey Scheduling
    • A visual depiction of when and how often each survey/measure was administered over the course of the study
  • Study and Data Metadata File
    • Survey timings, intervention triggering logic, data use agreements, regulatory information, preregistration information, and IRB information
  • Codebooks
    • Documentation for each substantive topic in the study
  • DataDictionaries
    • Documentation for each data file

In the same way that a researcher should be able to take a relatively unstructured data file and its corresponding data dictionary and reconstruct a meaningful database, a complete data manual should allow anyone to fully replicate every aspect of a study.


This site uses Just the Docs, a documentation theme for Jekyll.