CLiREN-LMS
Data Documentation and Metadata

Preparing a Documentation Package

11.5 Preparing a Documentation Package

30-45 minutes Applied Step 3 of 7
Reading 1

11.5 Preparing a Documentation Package

3 / 7
A useful final documentation package should be understandable to someone who was not involved in daily study operations. It should explain what the dataset contains, how it was created, how variables are defined, how missing values are represented, how derived variables were produced, and what restrictions apply. A practical documentation package may use this structure: ```text documentation_package/ README.md protocol_summary.md data_dictionary.csv codebook.csv derived_variable_specification.md cleaning_log.csv data_sharing_conditions.md scripts/ 01_prepare_final_dataset.R 02_create_codebook.R ``` The README should describe the package contents. The data dictionary should define the original database fields. The codebook should define the final dataset. The derived variable specification should explain calculations. The cleaning log should summarize major data quality checks and query closure. The data sharing conditions should state access restrictions and permitted uses.