Skip to content

Commit 92d51c8

Browse files
authored
Merge pull request #16 from MobleyLab/documentation_updates
Make a few updates to training materials - mainly links to other resources
2 parents 3a1ecf3 + e7f5eb1 commit 92d51c8

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

NewMembers/WorkingInTheMobleyLab.md

+1
Original file line numberDiff line numberDiff line change
@@ -211,5 +211,6 @@ In any case, given that I have limited time, there are a number of ways you can
211211

212212
## Useful reading on aspects of "doing science":
213213
- Kevin Plaxco on ["The Art of Writing Science"](http://doi.wiley.com/10.1002/pro.514)
214+
- [Fraser lab philosophy](https://fraserlab.com/philosophy/): Jamie Fraser's lab at UCSF has a lot of great background material relating to being in a research group, what the advisor-advisee relationship should look like, etc. Not all is directly relevant to us but most of it is. Worth reading.
214215
- Uri Alon on ["How to Give a Good Talk"](https://pubmed.ncbi.nlm.nih.gov/19854123/)
215216
- My talk on "Giving Good Talks" (link to be added later)

Writing/WritingTips.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document provides some tips on how to go about writing a paper and using th
66

77
Please: Get an ORCID (unique researcher identifier) and include it in your work: https://orcid.org/ (free)
88

9-
## Other related content
9+
## Other related content in our lab materials
1010
See the [group style guide](https://github.com/MobleyLab/Training/blob/main/Writing/StyleGuide.md) for language and word issues.
1111

1212
## Potentially helpful tips:
@@ -49,3 +49,10 @@ See the [group style guide](https://github.com/MobleyLab/Training/blob/main/Writ
4949
- It can be very satisfying to enter the room for an extended writing session, sit down together for a few hours, and leave with a draft that is complete enough to be able to continue fleshing it out on your own
5050
- This can require significant advance planning (e.g. I might not have a big block of time except on a weekend or if we plan far ahead)
5151
- Others could also help
52+
53+
## LaTeX tips
54+
- Usually we use Overleaf for shared editing/writing in LaTeX
55+
- Many journals ask revisions to be accompanied by something highlighting the changes which were made in revision. Be sure to save a version of your Overleaf before making these edits, then use `latexdiff` on the before-and-after versions to prepare a nice PDF with changes highlighted. This can also integrate with Git, e.g. [`git-latexdiff`](https://gitlab.com/git-latexdiff/git-latexdiff).
56+
57+
## Other recommended materials elsewhere:
58+
- [Helmut Grubmuller's writing guidelines](https://www.mpinat.mpg.de/631838/guidelines_english.pdf): These give a variety of useful and important tips on one of the key parts of writing and editing -- how to think about what the READER is thinking based on what you wrote. It's not just an issue of checking whether our words accurately represent what is in our heads -- but whether they get the reader to understand what we want them to understand. This also gives a variety of very concrete ways to improve scientific writing.

0 commit comments

Comments
 (0)