Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving the accessibility and educational values of the documentation #489

Open
chrisgorgo opened this issue Apr 27, 2017 · 1 comment
Labels
documentation effort: medium Estimated medium effort task help wanted impact: medium Estimated medium impact task
Milestone

Comments

@chrisgorgo
Copy link
Contributor

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 chrisgorgo added documentation impact: low Estimated low impact task labels Apr 27, 2017
@chrisgorgo
Copy link
Contributor Author

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

@oesteban oesteban modified the milestone: Future Jul 17, 2017
@oesteban oesteban added effort: medium Estimated medium effort task impact: medium Estimated medium impact task and removed impact: low Estimated low impact task labels Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation effort: medium Estimated medium effort task help wanted impact: medium Estimated medium impact task
Projects
None yet
Development

No branches or pull requests

3 participants