Skip to main content

How to make your research reproducible: Workflow Documentation

This guide presents best practices in documenting scientific research process to make the research reproducible.

Workflow

Workflow documentation – detailed steps of the workflow that capture the process of the scientific research

  • Weekly/daily notes on the project's stages
  • Documentation for the steps of the workflow

The Workflow of the scientific research.

Image adapted from https://doi.org/10.3389/fninf.2013.00052.

Good Practices to Capture the Research Workflow

How to well document the workflow of the research process:

  • The steps of the research starting from the design till fetching the data till producing graphs and tables in the scientific output
  • All the adopted libraries and the integrated algorithms
  • All the citations and information of code and data used
  • The input and the output of each step 
  • Tip: Electronic Notebooks, such as Jupyter help documenting the workflow 

Data Management Tools

Tools and Services:

 

 

Copyright © 2014-2019 The Regents of the University of California. All rights reserved. Except where otherwise noted, this work is subject to a Creative Commons Attribution-Noncommercial 4.0 License.