Preserving your work
Preserving your work includes developing enough documentation so your future self or another researcher can make sense of your work, enough so that they can at least reproduce your work and reuse it to answer their own research questions. It also includes where to store and share your work in data / code repositories.
Documentation
Only a few people with free time ahead of them will sit wondering about what to do next and think “what if I were to write some documentation!?”. Make it part of your workflow! and do not let it get out of sync too much as you iterate on your analysis.
Know your audience
There are actually various ways to document your work!! Here is a potential framework to help to think about those different types of documentation and their related audiences:
Your potential audience(s) for your documentation can be a future collaborator, an external researcher with no direct insight into your work, or a potential user of a tool you developed.
Prompts
What are the specific expectations from your discipline in terms of documentation and sharing data? For example, should you also share the raw data along with the analysis results?
Considering funding and publisher mandates, as well as disciplinary norms. Do you anticipate / have had any challenges regarding data sharing and preservation?
