Showing posts with label organization. Show all posts
Showing posts with label organization. Show all posts

Saturday, April 18, 2015

A Lesson from a Nobel-Prize Winner: How to tell the story of your results

Many scientists don’t realize it, but a good scientific article is like a novel: they both tell a story [1]. A well-written research article tells us about the search for the answer to a question. When we read the article, we’re introduced to what is known and unknown, which leads us to the research question. Then we follow the action of the Methods and Results, until we reach the climax: the answer to the question. The story finishes with a Discussion of what the answer means, which usually suggests new questions for new heroes (other scientists) to pursue—and these heroes don’t reward the story-teller with gold, but with citations!

One of the great heroes of science, Nobel Prize Winner Shinya Yamanaka, and his colleague, Kazutoshi Takahashi, give a master class in scientific storytelling in an article [2] that was a key to Yamanaka’s Nobel Prize. (If you want to download the article so that you can read the whole thing, you can get it for free from Cell’s open archive.)

Sunday, February 23, 2014

To learn how to organize your articles, study articles in high-impact English-language journals

In the fields that I'm familiar with—biology, biotechnology, and medicine—there is often a huge difference in the quality of writing between what is published in high-impact journals, and what is published in little journals. It seems to me that it's probably a positive feedback cycle: Because high-impact journals are more prestigious, more people want to publish there, so the editors can afford to demand clearer, better-organized writing. Because the writing is better, more researchers read the articles and find useful information and ideas in them. This leads to more citations, maintaining these journals' high impact factor. I think that it's not only the quality of the science that makes journals like Nature, Science, and British Medical Journal so popular and prestigious; it's also how clearly the ideas are presented in the pages of those journals.

The articles in these kinds of journals are worth using as models, even if you don't think that your study will be published in such a prestigious journal. First, you can be almost certain that the English in these journals is correct. Second, the way that the ideas are organized and presented in these journals will help you make your ideas clearer and more interesting to a wider range of readers, which will help your research get the attention it deserves.

I suggest that you find some articles that you find interesting in high-impact journals, and then make an outline of the main ideas in the article, to see how the authors organize their ideas. This will teach you how to outline and organize your own articles. To show you how to do it, I've made an outline of the main ideas in the introduction to an article entitled Oxytocin bolus versus oxytocin bolus and infusion for control of blood loss at elective caesarean section: double blind, placebo controlled, randomised trial (Sheehan et al. 2011) from BMJ (British Medical Journal).

Sunday, January 26, 2014

Before you write your article, write one sentence that will guide you

My scientific writing students and my editing clients often seem to get lost while writing their articles. It's as if they set out to cross the forests of Siberia without a map and compass, or a GPS, and with no clearer goal than the hope of reaching an ocean someday. And whereas some people might enjoy months or years of footloose wandering through a real wilderness, my clients generally don't enjoy the feeling of being lost while writing. So what I try to do is show them some techniques that will help them write a clear, focused article that is organized like those that are in many high impact journals.

Sunday, January 19, 2014

Pre-writing will help you get it right

"On my list of maladaptive practices that make writing harder, Not Outlining is pretty high…Get your thoughts in order before you try to communicate them to the world of science." (Silva 2007, 71)

Scientists need to organize their thoughts before they ask a native-speaker or an editing service to help them with their English grammar and usage. If the ideas in a scientific paper are disorganized or disconnected, the paper can be rejected or returned for revision because it is too difficult for the editor or reviewers to understand, even though there are few or no grammar errors.

To help organize and connect their ideas, almost all good writers do some kind of pre-writing that helps them to create, record and organize ideas. Pre-writing is especially important to prepare yourself to write in a second language, or to make sure that your ideas will be understood after translation. If the micro-scale aspects (vocabulary, grammar, etc.) of your writing are weak, you can compensate for this by strengthening the macro-scale aspects (organization and the connections between ideas).


Sunday, January 5, 2014

A good scientific article is like an organism, not a molecule

If you were sick, would you go to a biochemist or a doctor? I would go to a doctor, because in addition to biochemistry, she would have studied physiology, histology, anatomy, pathology, and many other subjects. A doctor understands how the body works at both the micro- and macro-scales.

What does this have to do with writing? Well, the problem is that when treating a "sick" piece of writing that needs to be improved, both students and teachers of scientific English often act like biochemists instead of doctors. They focus only on the micro-scale aspects of the writing such as whether a noun should be preceded by "a" or "the". This could be compared to treating a patient with a severe spinal deformity by giving him calcium supplements, then smiling and wishing him luck as you wave goodbye. Although the calcium supplements may indeed help the bones in his spine to become stronger, and weak bones may be part of his problems, he probably needs surgery and physical therapy to be able to stand up straight and breath easily. In the same way, grammar and vocabulary are important, but not enough for good writing. Macro-scale aspects, such as the way sentences, paragraphs and sections are organized and connected in good English writing, are also necessary to tell the story of your research.

Sunday, November 17, 2013

4 Keys To Writing A Successful Introduction


  • What is a good introduction to an English-language paper about scientific research?
  • How is a good introduction different from a literature review?
  • Why is an introduction necessary?

To answer these questions, we will look the characteristics that are shared by all good introductions to research articles.



An introduction to a scientific research article should answer 3-4 questions for the readers (Zeiger 2000, 107-109; Booth, Colomb and Williams 2003, 224; Swales and Feak 2004, 244; Schultz 2009, 34; Valiela 2009, 139-140; Harmon and Gross 2010, 3-13: Schimel 2012, 35-65):




1) What is the current state of knowledge about your research topic?
 
     1a) Why is this topic important, interesting, or both?

2) What is unknown about your topic? What is a gap in current knowledge, or a problem, or an inconsistency?

3) How did you attempt to fill the gap, solve the problem, or resolve the inconsistency? 



Question 1 is always answered in successful introductions. There should be enough information so that readers of the journal can understand the knowledge gap that you are trying to fill (Lindsay 2011, 24; Schimel 2012, 56). Remember that you should not give too much information; this is not a textbook, nor a test of how much you know about the topic.

Question 1a is not always answered; however, it is often answered (Zeiger 2000, 108-109; Swales and Feak 2004, 244) and several authors recommend that you do answer it (Harmon and Gross 2004, 11-13; Schultz 2009, 34-35; Valiela 2009, 139; Schimel 2012, 40-42). Explaining why your topic is important and interesting can help convince the editor to send your article out to the reviewers. It can also convince readers to finish reading your paper. Although many students of English do not answer this question, it is easy to answer if you learn a some key words and phrases that are relevant to your field.



Question 2 is always answered in a successful introduction. The answer helps convince the journal editor, the reviewers, and the readers of the novelty of your work. By clearly describing the knowledge gap, you create space for your article in the crowded, competitive world of modern research (Swales and Feak 2004, 243-244). Sadly, my personal observations agree with what Schultz (2009, 194) has written: many English-language learners do not answer this question well. Improving your answers to question 2 may be the key to improving your introductions.



Question 3 needs to be answered, and this is almost always done at the end of the introduction, as most students know. This information must be included because everything else in the introduction builds up to it. For English-language learners, it is important to learn how to answer question 3 briefly and precisely.



To sum up, a good introduction answers key questions for the readers. Although an introduction cites the literature, it should be different from a literature review. This is because a good introduction defines a knowledge gap; it prepares and motivates the readers to read about your research; and it helps convince the editor and the reviewers to accept your article. For these reasons, a good introduction is necessary. The language you need to write a good introduction will be an ongoing topic of this blog.

EXERCISE:
Read some introductions written by native-speakers. Find the parts where they answer the above questions. Is there any useful language you could use? Can you rewrite the sentences with the useful language so that they describe your research?

COMING SOON: Some examples with useful language.

REFERENCES:
Booth, Wayne C., Gregory G. Colomb, and Joseph M. Williams. The craft of research. University of Chicago Press, 2003.
Harmon, Joseph E., and Alan G. Gross. The craft of scientific communication. University of Chicago Press, 2010.

Lidsay, David. Scientific Writing = Thinking in Words. Csiro Publishing, 2011.
Schimel, Joshua. Writing science: how to write papers that get cited and proposals that get funded. Oxford University Press, 2012.
Schultz, David M. Eloquent Science. American Meteorological Society, 2009.
Swales, John M. and Christine B. Feak. Academic Writing for Graduate Students: Essential Tasks and Skills. The University of Michigan Press, 2004.
Valiela, Ivan. Doing Science: Design, Analysis, and Communication of Scientific Research. Oxford University Press, 2009.
Zeiger, Mimi. Essentials of writing biomedical research papers. McGraw-Hill, 2000.


Sunday, November 3, 2013

Good Paragraph Organization: An example from a classic article

We have a classic article for our first example of scientific writing with the kind of good paragraph organization that I explained in my last post. The article is the original short communication in which Watson and Crick proposed what is now an accepted structure for DNA (you can get the complete, original article for free here). I have deleted all the sentences except those at the beginning, and sometimes the end, of each paragraph. This way you can see how the most important sentences are in these places.

Before we look at their article, think about what you know about the structure of DNA. Then as you read the article, notice how the beginnings and endings of the paragraphs are almost like an abstract. These sentences summarize what most scientists know about the structure of DNA, plus some details that are of basic importance to geneticists, cell biologists, biochemists, and others in similar fields. This is how you should write your articles: the beginnings (and sometimes the endings) of paragraphs should be almost like an abstract of your work.

Sunday, October 27, 2013

The Key To Scientific Writing In English: Paragraphs with a point

"The beginning (often just the first sentence) should state clearly the subject of the paragraph...The first sentence...is the key."
–Robert A. Day, Scientific English: A guide for scientists and other professionals, 2 ed. (Oryx Press, 1995)

You're a scientist. You've studied English and you can read scientific papers in English. You understand the speakers at international conferences and enjoy talking with your colleagues from other countries. But your papers are returned with comments like, "Please improve the English."

I know scientists who have been asked to improve the English in their papers even after they have paid for professional translation. Some have even had their paper checked by a native-speaker or a professional proofreading service. But then their paper was returned with a comment like this: "Please have this paper checked by a native speaker or a professional proofreading service." When I've looked at their papers, I've seen that the problem wasn't grammar or vocabulary. The problem was organization.

Learning how to organize their paragraphs with good English-language style has helped my students and editing clients more than anything else. Their reviewers' comments have become more positive – some reviewers have even thanked them for writing their papers so clearly. I've been able to understand their papers more easily, which makes it easier to find and correct the little errors in their grammar and vocabulary. And my students have also noticed the change in their own writing – "Yes! It's clearer now," is a typical comment that I hear when students see the change in their writing.

There are usually just two types of paragraphs in good English-language science and technical writing: 
  1. Most paragraphs begin with the main or most important idea, then add details. The main idea of the paragraph is usually clearly written in the first sentence. If this idea is complicated, sometimes two or even three sentences are necessary. This structure often works well in the results section: give an overview of a result, then then details. For example, start by writing that predictions from modeling agreed well with experimental observations, then give details about how well they agreed. 
  2. Some paragraphs begin with an introduction to the main idea, add details, and build to a conclusion at the end. This often works well in the discussion section of a paper: Start with one of your results. Discuss the result, perhaps by comparing your result with results from similar studies. End with a conclusion, perhaps by suggesting why your results differ from those of other studies.

There are three reasons why this style of organizing paragraphs works so well. First, when you put the main or most important idea at the beginning, readers instantly know what the paragraph is about. This helps them to clearly understand the relationships between all the ideas that you are presenting. This clarity will help if you or your readers have any problems with the English in the paragraph.

The second reason why this style works well is because readers expect important information to be in certain places. In English, these places are the beginning and the end of paragraphs and sections. Some of my readers might be wondering why their high school teachers taught them to organize paragraphs in a different way, or didn't teach them that paragraphs need organization. This is because their native languages organize texts in a different way. This kind of organization is a part of each language, just like grammar and vocabulary. In fact, organization is so important that the study of how different languages organize texts is a part of discourse analysis, which is a sub-field of linguistics. So don't make the mistake of assuming that texts are organized the same way in every language. If you do, you risk confusing your readers. Many papers that I've read were confusing because the writer put unimportant details in places where we expect important ideas to be in English.

The third reason why this style works well is because your readers can quickly find the information they are looking for. The beginning of each paragraph tells what it is about, so it is easy for the readers to find what they want. And if you make things easy for your readers, you increase your chances of getting another citation.

Starting with next Sunday's post, we'll look at some examples of paragraphs and articles from the scientific literature, and have some different exercises that will help you with paragraph organization. Until then, here's an exercise to test your understanding of this lesson:

EXERCISE: Which paragraphs in this post are like the first type of paragraph above? Which are like the second? Keep reading to find the answers.