You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Something we mention briefly in the materials is documentation, but we don't go into much detail regarding it. We do talk about it in e.g. the Git, Quarto and Jupyter material, but given the discussions in #289 (comment) I think we can be more explicit about this.
One solution would be to first be more explicit throughout the materials in general that documentation is indeed a thing the students should be thinking about. This would entail going through the material and adding mentions where applicable. The second part would be to add explicit mentions in the lectures as well - I'm thinking in the Quarto/Jupyter lectures as well as the final putting-it-all-together lecture.
Another solution would be writing a whole new page just for documentation, but I'm unsure where that would fit into the schedule.
Other ideas?
The text was updated successfully, but these errors were encountered:
I think a section on documentation at the end, for binding it all together, would be a useful addition.
The paper The five pillars of computational reproducibility: bioinformatics and beyond has a section on documentation that could be expanded upon, and in particular includes some links to check lists which students could use as exercise material.
The MDAR stuff might be too much, but making a smaller checklist like README, compute resources used, data accessibility, etc would be useful to students.
Something we mention briefly in the materials is documentation, but we don't go into much detail regarding it. We do talk about it in e.g. the Git, Quarto and Jupyter material, but given the discussions in #289 (comment) I think we can be more explicit about this.
One solution would be to first be more explicit throughout the materials in general that documentation is indeed a thing the students should be thinking about. This would entail going through the material and adding mentions where applicable. The second part would be to add explicit mentions in the lectures as well - I'm thinking in the Quarto/Jupyter lectures as well as the final putting-it-all-together lecture.
Another solution would be writing a whole new page just for documentation, but I'm unsure where that would fit into the schedule.
Other ideas?
The text was updated successfully, but these errors were encountered: