Author Success Workshop · importance, timeliness What editors want High scientific & technical quality, ... in English Two factors to consider when writing a manuscript Importance

Nagasaki University

12 December 2015

Trevor Lane, PhD Kate Harris, PhD

Author Success Workshop: Effectively Communicating Your Research

S

Be an effective communicator

Your goal is not only to publish, but also to be widely read and cited

Develop professional writing skills

Write your ideas clearly

Logically present your research

Section 1

Develop professional writing skills

Professional writing skills

Increase impact

High quality research

Logical, engaging, useful message

Original and novel research

Well-designed, well-reported,

transparent study News value, importance, timeliness

What editors want

High scientific & technical quality, sound research/publication ethics,

registered human trials

High readability & interest; clear, real-

world relevance

Impact factor (for past 2 years) = No. of cites / No. of articles

Professional writing skills Impact and study design

Systematic

reviews of RCTs

Randomized controlled

trials (RCTs)

Other controlled trials

Observational studies (cohort, case-control,

cross-sectional surveys/audits, diagnostics)

Computer models (in silico), animal models (in vivo),

in vitro, case studies

Case studies, anecdote, opinion, technical,

simulation

Hypothesis

testing

{ Descriptive

Methodological {

{

Secondary

research

Primary

research

{ } Experimental (exposure assigned)*

}

} Non-

experimental

*


Research Article

Short Communication Case Study Technical Note Review Article Editorial Letter to the Editor

Brief report about a specific finding

Most common; full-length paper

Brief report about a specific situation

Brief report about a new methodology

Summary of recent advances in a field

Brief discussion about an interesting topic

Brief discussion about a published article

Types of articles

Professional writing skills Use reporting guidelines

PRISMA Systematic reviews &

Meta-analyses

STROBE Observational studies

CARE Case reports

CONSORT Randomized controlled

clinical trials

ARRIVE Animal studies

http://www.equator-network.org/


Logically organizing your ideas

Communicating in English

Two factors to consider when writing a manuscript

Importance of logic

Draft outline & abstract/title; Draft & revise

manuscript

Edit manuscript & finalize

abstract/title


Start with your illustrations

Where to start?

Your findings form the basis of your manuscript

First step: logically organize your display items

Logic, then language

Figure 1

Figure 2

Table 1

Figure 3

Logical flow (Chronology, Least to most

important, General to

specific, Whole+parts)

Is anything missing?

? Additional analyses?

Professional writing skills Prepare an outline

I. Introduction A. General background B. Related studies C. Problems in the field D. Aims

II. Methods A. Subjects/Samples/Materials B. General methods C. Specific methods D. Statistical analyses

III. Results A. Key points about Figure 1 B. Key points about Table 1 C. Key points about Figure 2 D. Key points about Figure 3 E. Key points about Figure 4

IV. Discussion A. Major conclusion B. Key findings that support conclusion C. Relevance to published studies D. Limitations E. Unexpected results F. Implications G. Future directions

Write down key ideas in bullet points, as IMRaD

No need for sentences or correct

English yet

Use reporting guidelines

Then, draft the title/abstract

List information from your reading in the appropriate section: Paraphrase with citations!

Professional writing skills Get feedback

Write your manuscript section-by-section – Less stressful – Get feedback after each section; set deadlines – Easier for your colleagues to review

Revise for content, overall logic, and journal style (see guidelines/past papers)

Edit for conciseness, clarity, consistency & accuracy

Get feedback from pre-submission peer review

Get language assistance

Professional writing skills Manuscript structure

How does your study contribute to your field?

What did you find?

What did you do?

Why did you do the study?

Title/Abstract

Introduction

Methods

Results

Discussion


Title/Abstract

Introduction

Methods

Results

Discussion

Title/Abstract

Methods

Results

Discussion

Introduction

Abstract /Title

write

The ‘write’ order


A is 4 times larger than B A is 4-fold larger than B A is 4 times as large as B

B is 4 times smaller than A

B is 75% smaller than A; B is 25% the size of A

A B

Write logical sentences


A is 4 times larger than B A is 4-fold larger than B A is 4 times as large as B

B is 4 times smaller than A

B is 75% smaller than A; B is 25% the size of A

A B

Comparing data, Method–Purpose, Condition–Effect, Reason–Result, Cause–Effect, Contrast, Similarity, Sequence, Addition, Concession, Exemplification

Write logical sentences


Academic English writing style

Logical connectors

Sequential

Causal

Adversative Although, Even though, Whereas, Despite,

However, In contrast,...

Because (of), To (+verb), Owing to, So that, Therefore, Thus, Hence, Consequently,…

Until, After, Before, While, Since, When, Then, Next, First/Second/Third,…

Conditional If, Even if, Unless, Whether or not, Provided

that, Otherwise,…


Readers focus at the end of the sentence to determine what is important.

1. You deserve the funding, but the study design is not perfect.

Which sentence suggests that you

will get funding?

2. The study design is not perfect, but you deserve the funding.



The study design is not perfect, but you deserve the

funding. The grant will be awarded in two stages.

Stress position

Topic position

The topic position introduces the idea of the current sentence

The stress position also introduces the topic of the next sentence



Almost all participants indicated a high level of satisfaction with the content, sequence and relevance of the ICT professional development program they attended. Only a few teachers reported that the duration of the professional development program was too short. However, the majority of the teachers reported that they developed an understanding of what TPACK is, and the way technology can enhance teaching and learning of difficult science concepts through the collaborative design of technology-enhanced science lessons in teams. “I developed an understanding of how TPACK can be applied in the design and teaching of a technology-enhanced lesson” said one of the pre-service teachers. A teacher from School C said if it was not the professional development he attended, he would not know how to use technology in teaching.

The pre-service teachers had the opportunity to further develop learning about technology integration in teaching after the professional development program had finished. They were invited to use their TPACK knowledge in workshops organized by the Ministry of Education and Vocational Training…

Topic sentence

Stress sentence Topic sentence

Supporting sentences


Source: Kafyulilo et al. Educ Inf Technol. 5 May 2015; DOI 10.1007/s10639-015-9398-0

Please see Activity 1 in your Workbook

Activity 1: Logical writing

Write effectively 1

Section 2

Customer Service Effective writing

Nature’s guide to authors:

Nature is an international journal covering all the sciences. Contributions should therefore be written clearly and simply so that they are accessible to readers in other disciplines and to readers for whom English is not their first language.

www.nature.com/nature/authors/gta/index.html#a4

“I should use complex words to make my writing more impressive.”


To ascertain the efficaciousness of the optional language program, we interrogated the optional

language program participants.

Improve readability


To ascertain the efficaciousness of the optional language program, we interrogated the optional

language program participants.

To determine the success of the program, we questioned the participants.

Improve readability

Customer Service Effective writing Avoid complex words

Preferred Enough Clear Determine Begin Try Very Size Keep Enough End Use

Avoid Adequate Apparent Ascertain Commence Endeavor Exceedingly Magnitude* Retain Sufficient Terminate* Utilization *OK in certain fields (magnitude of earthquakes, to terminate gene expression)

Customer Service Effective writing Delete unnecessary words

“A number of studies have shown that demographic factors...”

“...as described in our previous study.”

“...at a flow rate of 1.0 mL/min.”

“As a matter of fact, such a genetic mutation…”

“That is another reason why, we believe…”

“It is well known that most of the interviewed informants...” “It is well known that Most of the interviewed informants...”

“As a matter of fact, such a This genetic mutation…”

“A number of studies have shown that Demographic factors...”

“That is thus another reason why Therefore, we believe…”

“...as described previously in our previous study.”

“...at a flow rate of 1.0 mL/min.”

Customer Service Effective writing Delete unnecessary words

Avoid At a concentration of 2 g/L At a temperature of 37C In order to In the first place Four in number Green color Subsequent to Prior to Future plans; past history

Prefer At 2 g/L At 37C To First Four Green After Before Plans; history

Customer Service Effective writing Active voice

Sentences written in the active voice are:

simple direct clear easy to read

The mechanisms regulating enzyme activity were investigated.

Passive

We investigated the mechanisms regulating enzyme activity.

Active

Customer Service Effective writing Active voice is preferred

“Use the active voice when it is less wordy and more direct than the passive”.

“Use the active voice rather than the passive voice…”.

“As a matter of style, passive voice is typically, but not always, inferior to active voice”.

“In general, authors should use the active voice…”

ACS Style Guide

APA Style

Chicago Style Guide

AMA Style

“Use active voice. The use of active rather than passive voice produces clearer, more concise writing”

SPE Style

“Wherever possible, use active verbs that demonstrate what is being done and who is doing it…”

ASCE Style

“Use active voice by default; research shows readers comprehend it more quickly than passive voice…”

IEEE

Customer Service Effective writing Avoid reader confusion

Is this sentence in the active or passive voice?

In this study, a mathematical equation for domestic happiness was developed, using factor analysis.


Is this sentence in the active or passive voice?

Passive voice




Tunn et al. created a questionnaire to probe how happy people feel in their households.3

Avoid reader confusion

Part of the Introduction






Who did the work in this study?

The author ? Tunn et al. ?





In this study, we developed a mathematical equation for domestic happiness using factor analysis.


Fix stacked and misplaced modifiers

The final analyzed sample only appeared blue temporarily because we had added the especially

prepared reagent that we were testing slowly.


Fix stacked and misplaced modifiers

The final analyzed sample only appeared blue temporarily because we had added the especially

prepared reagent that we were testing slowly.

The final sample that we analyzed appeared blue only temporarily, because we had slowly added the

test reagent.


Activity 2: Effective Writing 1


30 words

Economists considered Tanaka Industries, a large Japanese trading corporation founded in 1916 outside of Nagoya by Ichiro Tanaka, to be a model in the development of modern employee conditions worldwide.

Use short sentences


30 words

Economists considered Tanaka Industries, a large Japanese trading corporation founded in 1916 outside of Nagoya by Ichiro Tanaka, to be a model in the development of modern employee conditions worldwide.

Use short sentences


Economists considered Tanaka Industries to be a model in the development of modern employee conditions worldwide. This large Japanese trading corporation was founded in 1916 outside of Nagoya by Ichiro Tanaka.

16 words

15 words

One idea per sentence

Use short sentences


Readers expect…

verbs to closely follow their subjects heavy ends (not starts) of clauses

Subject

The viral infection that the patient caught on a trip to an outbreak-prone area in Africa spread among the hospital staff quickly.

The patient caught a viral infection on a trip to an outbreak-prone area in Africa. This infection spread quickly among the hospital staff.

Verb

Write clear sentences


Avoid nominalizations

Use strong verbs instead of converting a verb into a noun

Estimate Estimation

Decide Decision

Assess Assessment

We made a/an… We conducted a/an…

Extra, weak verb

We decided… Clear, short, and direct

Use strong verbs

Customer Service Effective writing Clarify the subject

“Titania (TiO2) has been extensively investigated because of its potential usefulness for monitoring analytes of biomedical importance, such as dopamine, glucose, glutamate... It has three primary polymorphs in nature…”

“Titania (TiO2) has been extensively investigated because of its potential usefulness for monitoring analytes of biomedical importance, such as dopamine, glucose, glutamate... TiO2 has three primary polymorphs in nature…”

?

Customer Service Effective writing Use correct verb tense

Present

Present perfect

Past

Stating an accepted fact Stating current implications

Referring to previous results that are still relevant

Referring to what you did in the current study

Introduction Discussion

Introduction Discussion

Methods Results

“The CRISPR/Cas system is one of the most powerful tools for gene editing.”

“Nanobiocatalysts have been shown to increase the reaction rates of...”

“Silanization increased the resin bonding strength at the fiber post...”

Customer Service Effective writing Correct verb tense – Case study

“Several ubiquitination models for proteolysis were described.”

Introduction

“Several ubiquitination models for proteolysis have been described.”

“Our laboratory conducts studies using E1 and E2 enzymes….”

“Our laboratory has been conducting studies using E1 and E2 enzymes. These enzymes are...”

“Our laboratory has conducted studies using E1 and E2 enzymes. These enzymes were…”

Present perfect: “So far”, Experience, News/announcing, Change topic/new paragraph

Customer Service Effective writing Correct verb tense – Case study

“We have taken the body fat percentage…”

Results

“We measured the body fat percentage…”

“A shift in the patient’s attitude is observed…”

“A shift in the patient’s attitude was observed…”

“We observed a shift in the patient’s attitude …”


“This result suggested that these peaks were from…”

Discussion

“This result suggests that these peaks originated from…”

“These computed tomography results confirmed that…”

“These computed tomography results confirm that…”

Signal words: Suggest, demonstrate, confirm, support

Correct verb tense – Case study


Respectively is used for corresponding list items

The two values were 143 and 21, respectively.

The values for groups A and B were 143 and 21, respectively.

The two values were 143 and 21.

Avoid mistakes 1


Compared with is for saying how things are different

The toxicity of the new scaffold was reduced

compared to the previous scaffold.

The toxicity of the new scaffold was reduced compared with that of the previous scaffold.

The toxicity of the new scaffold was lower than that of the previous scaffold.

Avoid mistakes 2


Due to means “caused by” or “attributable to”

Due to the heavy rain, the samples became unusable.

Owing to the heavy rain,… Because it rained heavily,…

The loss of usable samples was due to the heavy rain.

Avoid mistakes 3


Don’t use numbers to start a sentence

506 patients were recruited.

We recruited 506 patients. / In this study, 506 patients were recruited.

Five hundred and six patients were recruited.

Avoid mistakes 4


Don’t use new words; use “that” for defining terms

Some of the data from the last 2 years, which we inputted into the analysis, impacted on the overall

calculation.

Some of the data from the past 2 years that we entered into the analysis affected the overall

calculation.

Some of the data from the past 2 years that we included in the analysis skewed the overall calculation.

Avoid mistakes 5


Activity 3: Effective Writing 2

Documents

Author Success Workshop · importance, timeliness What editors want High scientific & technical quality, ... in English Two factors to consider when writing a manuscript Importance