Course:KIN570/TOPICS/Effective Communication/Effective Writing

From UBC Wiki

Structure

Constructing the manuscript[1]


Title Page and Abstract
1. Be specific (avoid "The Effect of" statements).
2. Attempt to include the results of your experiment in the title.
3. Summarize the entire experiment in the abstract. Do not point the reader towards the document for more information.

Introduction
1. A manuscript is not a thesis -- keep it concise and keep the logical flow clear.
2. This is not the discussion -- only include information that justifies the need for your study.
3. Present the "knowledge gap".

Methods
1. Why you chose the given methods should NOT be mentioned. Leave this for the discussion.

Results
1. Statistics do not TELL us anything. Statistics EVIDENCE what we have already stated.
2. Use statistics as if they are an academic reference for a statement.

The results of the one-way ANOVA show a significant effect of treatment on performance (F=5.103, p<0.01).
Treatment 1 improved performance significantly more than Treatment 2 (F=5.103, p<0.01).

Discussion
1. Do not emphasize other authors' work. Put their work in the context of your work.
2. Put your results in the context of theory.

Clarity

Improving the readability of your document[2]

Active voice vs. Passive voice
1. In general, active is clearer than passive
"The reported fear score was found to be eight." - Passive
"We found the reported fear score to be eight." - Active

Keeping it simple
1. Avoid jargon whenever possible.
2. Only use abbreviations for very common things or if you mention the phrase more than 10 times.
3. Put old information at the beginning of the sentence.

Common mistakes[3]

1. Use "that" when what follows is necessary to understand the sentence. Use ", which" when it is not.
"Subjects were able to produce voluntary activation in trunk muscles, WHICH contributes to postural control."
"Subjects were able to produce voluntary activation in trunk muscles THAT was comparable to controls."

2. Use "continual" when there are clear increments. Use "continuous" when there is not.
"We saw CONTINUAL improvements in trunk stability at the one, two, and three month follow-ups."
"We recorded electromyography CONTINUOUSLY throughout the entire experiment."

References

  1. Knight, K., & Ingersoll, C.D. (1996). Structure of a scholarly manuscript: 66 tips for what goes where. Journal of Athletic Training, 31, 201-206
  2. Knight, K., & Ingersoll, C.D. (1996). Optimizing scholarly communication: 30 tips for writing clearly. Journal of Athletic Training, 31, 209-213.
  3. Michael Alley and the craft of scientific writing (Springer-Verlag, 1996). Writing exercises for engineers and scientist. http://www.writing.engr.psu.edu/exercises/index.html