nipreps / fmriprep

fMRIPrep is a robust and easy-to-use pipeline for preprocessing of diverse fMRI data. The transparent workflow dispenses of manual intervention, thereby ensuring the reproducibility of the results.
https://fmriprep.org
Apache License 2.0
628 stars 290 forks source link

Improving the accessibility and educational values of the documentation #489

Open chrisgorgo opened 7 years ago

chrisgorgo commented 7 years ago

Current documentation (especially workflow description) is ok when it comes to answering fairly technical and specific questions ("What was used to perform skull stripping?"). However, to make FMRIPREP more appealing to less knowledgeable users we should add more educational content to the documentation. The workflow description should be understandable by someone who never performed fMRI data preprocessing - explaining each processing step, describing the details of our implementation, and linking to other resources on the web and/or papers which users can use to deepen their knowledge.

Resources that could be useful when adding more educational content:

chrisgorgo commented 7 years ago

Here is an example of questions that we should see less of if the documentation is improved: https://neurostars.org/t/confounds-from-fmriprep-which-one-would-you-use-for-glm/326/5?u=chrisgorgolewski