Skip to content

Commit

Permalink
Create Writing&Reviewing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stefano-galelli authored Jun 5, 2024
1 parent c0dd061 commit 0002be6
Showing 1 changed file with 81 additions and 0 deletions.
81 changes: 81 additions & 0 deletions docs/Writing&Reviewing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
layout: page
title: Writing and Reviewing
description: >
Resources for writing and reviewing your first paper.
hide_description: true
sitemap: false
---

# Writing

Are you ready to write your first paper? Or are you perhaps curious about the steps needed to write a paper? If the answer to these questions is *yes*, the resources listed below will turn out to be useful.

## LaTeX and Overleaf

First, and perhaps most important, what software do I use to write my paper? In the CIS Lab, **we use LaTeX**--a software system that supports the preparation of articles and books. The learning curve for LaTeX is a bit steep, but the advantages offered by this system are substantial. Among the various software solutions supporting LaTeX, we use [Overleaf](https://www.overleaf.com), a collaborative and online LaTeX editor. Here are a few recommended steps:

- Open an account on Overleaf. The free account provides enough functionalities for hosting a paper and learning LaTeX. For more advanced functionalities (e.g., track-and-changes), please contact [Stefano](mailto:[email protected]): we have a standard plan that we use to host collaborative papers.
- If you are new to LaTeX, please read the [guide](https://www.overleaf.com/learn) offered by Overleaf. Note that there are several other guides and tutorials available online.

Note that by using Overleaf you don't have to use any software on your computer. In case you want to do so, consider installing [TeXShop](https://pages.uoregon.edu/koch/texshop/) (MacOS) or [TeXstudio](https://www.texstudio.org) (Windows, Unix/Linux, and MacOS).

## Books

- [Writing Science: How to Write Papers That Get Cited and Proposals That Get Funded](https://www.amazon.com/Writing-Science-Papers-Proposals-Funded/dp/0199760241) by Joshua Schimel is a **must-read for all CIS Lab members**. This book provides a wonderful introduction to scientific writing, from the overall structure of a paper or proposal to individual sections, paragraphs, sentences, and words. A **compulsory exercise is to read this book while writing your first paper**, basing your writing on what explained in each specific chapter. A cheat sheet of Schimel's book is available [here](https://github.com/Critical-Infrastructure-Systems-Lab/Critical-Infrastructure-Systems-Lab.github.io/blob/main/_data/Writing-Science-Cheatsheet.pdf).
- [First you write a sentence](https://www.penguinrandomhouse.com/books/607260/first-you-write-a-sentence-by-joe-moran/) by Joe Moran is another great book that has shaped our approach to scientific writing.

## Articles

- [Simple rules for concise scientific writing](https://aslopubs.onlinelibrary.wiley.com/doi/10.1002/lol2.10165) by Scott Hotaling.
- [Ten Simple Rules for Getting Grants](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.0020012) by Philip Bourne and Leo Chalupa.
- [How (Not) to Write an Abstract](https://ascelibrary.org/doi/full/10.1061/(ASCE)WR.1943-5452.0000790) by Tom Walski and David Watkins.
- [When I use a word 
 Declarative titles](https://academic.oup.com/qjmed/article/103/3/207/1589103) by Jeff Aronson.
- [How to construct a Nature summary paragraph](https://www.nature.com/documents/nature-summary-paragraph.pdf)

## Courses, Blogs, and other resources

- [SCICOMM@CORNELL](https://scicomm.cornell.edu), a guide to science communication resources at Cornell.
- [Writing a manuscript and mastering abstracts: a guide for authors](https://www.springernature.com/gp/researchers/the-source/blog/blogposts-getting-published/writing-a-manuscript-and-mastering-abstracts/25261924)
- Joshua Schimel's [blog](https://schimelwritingscience.wordpress.com)

## To do list

- Open an account on [Overleaf](https://www.overleaf.com).
- If necessary, start learning LaTeX using the resources posted here.
- Read Joshua Schimel's book.
- Feel free to complement your knowledge with other resources listed here and elsewhere. Importantly, please contribute to this page!

# Reviewing

Ok, so you have now been invited to review a paper. Should you accept? If you have time, the appropriate expertise, and no conflict of interest, the answer should be **yes**. There are many reasons for which serving as a reviewer--and later as an editor--is important. First, it is a **service we provide to the scientific community**; and communities work well when everybody contributes to them. In a more pragramtic fashion, you can see this matter in the following way: every paper that we submit (and gets reviewed) 'generates' two or three reviews; so, for every paper that we submit, we should provide at least two reviews. Second, **reviewing is a great way of learning**; it helps us become better scientists and better communicators.

Here are a few tips for your first review:

- Follow the guidelines provided by the journal you are reviewing for. Sometimes they are lengthy, but they are there for a good reason as they provide clear indications on what the editor would like to hear from you.
- Be kind, respectful, and constructive--always.
- Support all your statements and criticisms with appropriate facts and / or references.
- Remember that your ultime goal, as a reviewer, is to provide a detailed assessment of somebody else's work.

There are several online resources that serve as good introductions to the peer review process. Here are a few we like:

- [A Quick Guide to Writing a Solid Peer Review](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2011EO280001) by Kimberly Nicholas and Wendy Gordon.
- [Peer Review Resources - Wiley](https://authorservices.wiley.com/Reviewers/journal-reviewers/tools-and-resources/index.html)

















<!-- {% include big-cat.html %} -->

0 comments on commit 0002be6

Please sign in to comment.