Workflow documentation explains how the data management process works. It is different from code comments, though they support each other. A workflow document should allow another competent person to understand what scripts exist, what order they are run in, what inputs they require, what outputs they produce, and how outputs are reviewed.
A simple workflow README may include:
# Weekly Data Management Workflow
1. Export REDCap records as CSV and save to data_raw.
2. Run scripts/01_import_data.R.
3. Run scripts/02_clean_and_prepare_data.R.
4. Run scripts/03_descriptive_summaries.R.
5. Render reports/weekly_data_quality_report.qmd.
6. Review outputs with the data manager.
7. Enter approved queries into REDCap.
8. Archive the rendered report in outputs/reports.
This is not a replacement for a data management plan, but it is a practical guide for routine work. It reduces dependency on one person and supports continuity when staff change.
Workflow documentation should also describe folder structure, naming conventions, package requirements, and known limitations. If a script assumes a particular REDCap export format, that should be stated. If reports should only be generated after query review, that should be stated.