Skip to content

Commit 28564f2

Browse files
authored
Merge pull request #66 from LevensteinLab/writing-section
added a section on writing
2 parents ef1acc5 + 3ff1801 commit 28564f2

5 files changed

Lines changed: 68 additions & 5 deletions

File tree

docs/Policies/hours_remote_vacation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ As our work is predominantly theoretical/computational, we have a lot of flexibi
44

55
If it fits you, I would encourage you to plan one day a week where you work from home (or elsewhere out of office). This shift in perspective can be helpful for your work and I encourage you to take advantage of this time to think freely and critically about your project and current approaches. I do ask that you plan to attend lab meetings in person -- in my experience, remote attendance encourages people to listen (at best), rather than participate, in lab meetings. Also, I ask that you plan to be physically in lab 3-4 days a week. Of course, this can vary week to week and exceptions will be made to fit people’s circumstances.
66

7+
I will sometimes message at evenings, or on weekends. Please do not think this means I expect you to act on, or even read, the message until the next workday unless it’s specifically designated as urgent/time sensitive. It only means that I thought of something relevant to your project and didn’t want to forget. If you'd prefer I not message you outside of working hours (unless urgent), please let me know and I'll schedule these for the next workday.
8+
79
I expect you will be taking vacations. I usually take off from the weekend before Christmas until the weekend after new years, a few days around thanksgiving, a week or two over the summer, and the various official 3-day weekends. I’ll lightly respond to emails during these times, do some reading, maybe some writing. But in general I like to use this time to recharge, spend some time with family and hobbies, and I encourage you all to do the same. For more about work-life balance in academia, please see [Work-life balance] **TODO: @dan include link**.

docs/Resources/mailing_lists.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ Mailing lists/groups you may wish to sign up for/get added to, and how. Click th
99
1. [Neuroscience mailing list](https://mailman.yale.edu/mailman/listinfo/neuroscience)
1010
2. [Interdepartmental Neuroscience Program (INP) mailing list](https://mailman.yale.edu/mailman/listinfo/inp_general)
1111
3. *[Wu Tsai Institute (WTI) mailing list](https://mailman.yale.edu/mailman/listinfo/wti-members)
12-
4. Research in Progress (RIP) mailing list - Ask Dan to email on your behalf
13-
5. *[WTI NeuroAI Journal Club mailing list](https://mailman.yale.edu/mailman/listinfo/wti-neuro-ai-jc)
14-
6. [APplied PHilosophy In NEuroscience (APHINE)](https://yaleconnect.yale.edu/aphine/home/)
15-
7. [Quantitative Biology (QBio) talks](https://mailman.yale.edu/mailman/listinfo/qbio)
16-
8. Foundations of Data Science Institute talks - visit `subscribe.yale.edu` and find "FDS Announcements" under the "Research Administration" category
12+
4. *[WTI Trainees mailing list](https://mailman.yale.edu/mailman/listinfo/wti-trainee)
13+
5. Research in Progress (RIP) mailing list - Ask Dan to email on your behalf
14+
6. *[WTI NeuroAI Journal Club mailing list](https://mailman.yale.edu/mailman/listinfo/wti-neuro-ai-jc)
15+
7. [APplied PHilosophy In NEuroscience (APHINE)](https://yaleconnect.yale.edu/aphine/home/)
16+
8. [Quantitative Biology (QBio) talks](https://mailman.yale.edu/mailman/listinfo/qbio)
17+
9. Foundations of Data Science Institute talks - visit `subscribe.yale.edu` and find "FDS Announcements" under the "Research Administration" category
1718

1819

1920
It's also possible to check out all `mailman@yale` links or manage your subscriptions with the links below:

docs/Resources/recommended_reading.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131

3232
- https://www.cell.com/trends/neurosciences/abstract/S0166-2236(21)00144-2
3333
- https://direct.mit.edu/neco/article-abstract/33/11/2908/107071/Replay-in-Deep-Learning-Current-Approaches-and
34+
- https://www.tandfonline.com/doi/abs/10.1080/095400996116910
35+
- https://www.nature.com/articles/s41467-020-17866-2
3436

3537
**hippocampus**
3638

docs/Resources/writing.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Writing
2+
3+
Over the course of your time in the lab we will write a lot together.
4+
Manuscripts, fellowship/grant applications, conference abstracts…
5+
6+
Writing is a craft, and scientific writing is a specific kind of writing.
7+
Writing effectively takes a lot of time and work.
8+
From the get go, I recommend everyone **watch [this lecture on how to write well](https://www.youtube.com/watch?v=vtIzMaLkCaM)**.
9+
Watch it now, before you have to write anything. And watch it again in a year or two.
10+
11+
Part of your training in the lab is to improve your writing skills, and IMO it’s one of the most important parts.
12+
Remember: your three main outputs in the lab are figures, ideas, and code.
13+
Writing is a tool for developing your ideas, and it’s the most tangible way you will communicate those ideas.
14+
Writing well will get you a job, and it will improve your science,
15+
because writing is a thinking tool as much as it’s a communication tool
16+
(WARNING! these are not the same, see the [lecture](https://www.youtube.com/watch?v=vtIzMaLkCaM) 😉).
17+
18+
A heads up: when you get a draft back from me, it will likely have a lot of red ink.
19+
[More red ink is good](https://x.com/gbosslet/status/1109544049583841280).
20+
Make sure to give yourself, and me, enough time to work on drafts together
21+
(e.g. I want to see abstract drafts a week before conference submission).
22+
For any document you submit, expect a lot of comments/suggestions and few rounds of back-and-forth editing.
23+
This is a dialogue of iterative, collective development of your document, your project, and your abilities as a writer;
24+
not a corrective exercise.
25+
I prefer to use google doc because I think it has the best tools for co-writing.
26+
27+
**Tips and tricks**
28+
29+
30+
*Editing is the majority of writing*. Editing is a craft you can hone. Here is a collection of tips and tricks for editing I’ve collected over the years.
31+
32+
- **Always consider your reader**. Who are they? Why are they reading your document? How can you help them out? They will always thank you for making things clearer, more concise, and easier for them to follow.
33+
- **For each sentence, interrogate it: "what is your purpose?"** It should contribute something specific to the document at hand, and that something should never be “tell the reader you know this thing”.
34+
- **Tell your reader only what they need to know** in order to understand and care about what you’re telling them, no more. Your job is not to convince your reader that you know stuff.
35+
- **Say it in a lot of words, then get rid of most of them** When you don’t know how to say something concisely: don’t worry about concision, write it out in as many words as possible, then edit them down. You’ll often find that the reason you couldn’t express your idea concisely is because it wasn’t fully developed, and the act of writing → editing will help you develop the idea. Note: this is the vomit method on a small scale.
36+
- **Filler sentences** If you don't know how to say what you want to say, use a [filler sentence](https://x.com/realscientists/status/1369995669147107328) that serves the same purpose, which you will edit/expand later. Separate out "what is this sentence for" from "what are the words in this sentence".
37+
- **Look out for referents.** Words like “this”, “that”, et al. What do they refer to? Is it clear to the reader? Can they be replaced with something clearer, or more informative?
38+
39+
*The first draft, on the other hand, is dark magic voodoo shit*. Where editing is a craft you can hone, writing from scratch is a different dumpster fire every time you put a pen to a blank page. Here are a few methods to get it out and move on with your life.
40+
41+
- **The vomit method/shitty first draft**. This can be summed up as: You need to write words. It's ok if they are garbage words. You can fix them later. TBH, all first drafts are shitty first drafts whose only purpose is to exist so you can move on to editing, and the vomit method is just one way to get it out of you as quickly as possible.
42+
- **The outline-first method**. This sounds like elementary school stuff but it can really work. Collect the pieces you want/need to include in your document and arrange them in a bulleted list. Organize the overall structure of the document, identify missing pieces. The idea is to focus on pieces and structure not on language. Once you have the pieces in a structure you like, turn them into complete sentences and delete the bullet points.
43+
- **The San Antonio method.** This is basically the vomit method with at least one coauthor and a whiteboard. TL;DR one person’s job is to write on the board and everyone else’s is to throw out ideas. The whiteboard author should take an attitude of “yes, and”, note down anything that’s been said, and should try to prompt thinking about how they relate. Afterword, arrange your notes into an outline.
44+
- **Generative AI**. I would not recommend using generative AI for your first draft, unless you’re recombining words you’ve already written. For example, if your fellowship asks for a community service statement, and you’ve already written three of them for past applications but the prompt was slightly different and you’ve done some new stuff since then. You can throw your old writing samples and updated CV and ask: “I’m writing a statement for a fellowship application. Here is the prompt and some previous statements I’ve written. Please combine them to fit the prompt, preserving my writing voice and, ideally, the actual language I used, as much as possible”. Once you have a collection of past submissions this will save a lot of time, but I would highly recommend against using GenAI to help with writing anything new - it tends to write many fluffy nice-sounding language without any real content, which is the exact opposite of what you want for subsequent editing, and it robs you of the idea-generation phase of writing which is arguably the most important part.
45+
46+
_Develop a regular writing practice_
47+
48+
_Advice on specific pieces of academic writing (Links/advice to come)_
49+
50+
- Writing an Abstract
51+
- Structuring your paper
52+
- Specific Aims: by the time your reader gets to your aims, they should be able to guess what they are without reading them. That is, you should have given them exactly and only the information they need to have a burning question, which your aims spell out a way of asking and answering. See [Anatomy of a Specific Aims](https://www.biosciencewriters.com/NIH-Grant-Applications-The-Anatomy-of-a-Specific-Aims-Page.aspx) for more.
53+
54+
## Miscellaneous resources
55+
- [Mensh and Kording 2017 - "Ten simple rules for structuring papers"](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005619)
56+
- [Carandini 2018 - "How to write a paper (with me)"](https://drive.google.com/file/d/1RFzp3BV1tT4XQTGkGmopkmanjkN9UptD/view)
57+
- [The Perfect Sentence Vortex and How to Escape It](https://researchinsiders.blog/2013/03/05/the-perfect-sentence-vortex-and-how-to-escape-it/)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ nav:
2323
- Travel: Resources/travel.md
2424
- VPN: Resources/vpn.md
2525
- VS Code: Resources/vs_code.md
26+
- Writing: Resources/writing.md
2627
- Onboarding: onboarding.md
2728
- Contact: contact.md

0 commit comments

Comments
 (0)