10. Research Notes SOP¶
SOP: Create a KRG Research Note Repository
- Create a GitLab Group with the project name (e.g.,
rpff) - Fork The KRG research notes tempalte under the targeted project group namespace
- Unlink the fork
- Place the research note repository link to the project specific Teams channel
visualization
- Automatically rendered page: https://
<group-name>.gitlab.io/research-notes/ - (optional) If not familiar with MKDocs and GitLab Pages, one can use Google Slides or PowerPoint on MS365 to assist presentation; however, complete (and verbose) research notes should be maintained in the associated git repository
record procedures and thoughts
- significance statement
- literature
- problem statement
- proposed solution
- software and procedure script
- data (if not excessively large, say within 100 MB, use
git-lfsfor this purpose if possible)
If in doubt, record everything and worry about cleaning up later
keep it simple
Research notes provide the basis for more refined presentations such as conference talks and research papers. Since research notes are internal documents, keep it as simple as possible for fast turnover time and leave refinements when preparing manuscripts.
start/end each research meeting by reviewing/writing tasks
Use research notes as checkpoints to reduce overhead when restarting meetings.