Scientific Writing Style

Scientific Writing Style…with thanks to Chris Power

These slidesPlease note that these are the slides that I used in my lecture on 15 November 2013, but supplemented with some additional examples.

PurposePrevious lecture

Why we write

TodayHow to write

‘scientifically’

Scientific writingEverything you say must be backed by evidence

From the literature‘Tactile maps (Figure 1) can be an effective tool to aid route learning for people with visual disabilities [1, 8]’

From your results‘As shown in Figure 4, road crossings were rated as the most important landmarks.’

There is no place for opinion

‘It was surprising to see that…’That is, your results did not support your hypothesis. Too bad – but whether you were surprised or not is irrelevant.

‘Nevertheless, I believe that…’Who cares what you believe? What can you prove?

Finding your scientific voice

It is not a highly personal narrative“I studied different sources in the library. I attended the class on…”It does not have to be very convoluted, full of complex terms“If skin deformation is a critical factor for roughness perception (Taylor and Lederman, 1975), then it would seem reasonable to argue that roughness perception in virtual reality might be more similar to roughness perception in the physical world via a probe, than via a bare finger.”

46-word sentence - I have to draw breath, that is not a good sign

Sentences building to paragraphs

‘Skin deformation may be a critical factor for roughness perception (Taylor and Lederman, 1975). Roughness perception in the physical world is usually undertaken with the bare fingers and thus involves skin deformation; sometimes it may be undertaken with a probe or other device, and no skin deformation is involved. Therefore it is reasonable to argue that roughness perception in virtual reality, which inevitably uses a probe, is more similar to roughness perception in the physical world via a probe than via a bare finger.’

ReadabilityOriginal sentence: Flesch Ease of Reading Index 33.4Re-write: Flesch 47.8

These reading indices are not very good, but can occasionally be a useful tool

Keep it as plain and simple as you can

‘Everything should be made as simple as possible, but no simpler’

Albert Einstein

Keep it as plain and simple as you can

Try to find a way of writing that is somewhere in the middle, that you are comfortable withA certain amount of use of the first person is fineKeep sentences short always (break the argument down into its logical parts for the reader to understand) Keep words short and simple as possible - except for technical terms

JargonJargon is fine – as long as you are using it with people who understand it

Doctor to medical staff versus doctor to patient

‘Acceptable’ long or jargon words in HCImultimodality, augmented reality, avatar, cognition, keystroke, Wizard of Oz…although some of those might need at least a footnote

See later

Do not go all literary, darling

Do not feel that you are expected to write in some very literary style Do not vary terms for interest (see defining terms later)

‘Volunteers acted as evaluators. The participants…’

Do not suddenly vary topic Do not intentionally create suspense

Do not be too informal, either

Contractions such as don’t, can’t and wasn’t have no place in a formal document

do not, cannot and was not

They are a way of documenting the way we speak

- and signalling informality

Precision and rigor!A scientific style is usually as precise as possible

Avoid vague terms ‘the web users tended to…’Make sure you know the meaning of complex words you use ( e.g. sequencing attribute grammar)Avoid colloquial/culturally specific expressions

‘training wheels interfaces …’

‘nailed his colours to the mast’

Think about your reader(s)!

You need to persuade your reader that this is an important document/project and lead them through the information

The storyDo not discuss a concept for three pages and then define it - reader needs a definition at the beginning of a discussion of the conceptProvide introductory/bridging sentences/phrases

‘The next section will introduce concepts of web accessibility and usability in order to establish the criteria for evaluations of websites by users.’

Define terms (and abbrevs) and stick to them!

Early in your paper, define any technical terms you need to, set up abbreviations and then stick to them In the case of technical terms, if you vary them, the reader may think you mean something different

‘web user’, ‘evaluator’, ‘participant’, ‘tester’

are these all the same lot of people?

Abbreviations and acronyms

Spell out all abbreviations and acronyms the first time you use them

Even ‘common’ ones‘A long standing controversy within human-computer interaction (HCI) is…’‘The navigation device relies on GPS (the Global Positioning System).’

Abbreviations and acronyms

Specifying an abbreviation (abbrev) and then not using it is just irritating for the reader - last thing you wantMake a list of abbreviations as you go along, at the end check that you have introduced them on the first instance of their useDo not use too many abbreviations - again, think of the mental load on the poor reader‘This paper discusses the role of the training wheels interface (which we will refer to as TWI) in word processors’

If there is disagreement about terminology, key concepts?

Do discuss different researchers’ definitions, concepts if appropriateBut make it clear where you stand - you are now an expert!

‘According to Jones (2001), web accessibility is… However, Smith (2004) defined web accessibility as… In this thesis, I will follow Jones…’

Or: ‘In this thesis, I will define accessibility as…’

Conceptual analysis and definition of new terms may well be an important part of your contribution to the field

Politically correct interlude

If writing about human beings, use non-sexist terminology

Not: ‘The web user was shown a scale on which to rate the usability of each site. He was asked to study this…’

Easy way out - use the plural!But: ‘Web users were shown a scale on which to rate the usability of each site. They were …’

If writing about particular groups of humans, personalize them

Not: ‘The elderly cannot see colours with the accuracy…’But ‘Many elderly people cannot see colours…’

Political correctnessLanguage is powerfulIt is easy to cause offenseSo, try to avoid it

but not at the expense of claritye.g. what is a ‘visually challenged person’?

How do I start?See

Thimbleby, H (2008) Write now!, (in) Cairns. P & Cox, A. (eds.) Research Methods for Human-Computer Interaction, Cambridge University press, pp.196-211

Using other people’s words

This might be something about plagiarism, but let us think of this in another way

Using other people’s words

If you literally use the words of other authors, it is not your own voice, and will lead inevitably to a very uneven style - a bit from one author, a bit from another, or worse, a bit from X, a bit from you, a bit from YOne thing you are being assessed on is the ability to explain other people’s work in your words

QuotationsSo… keep quotations fairly rare and keep them briefSave them for really key points

When to quoteWhere the original author’s words are critical

Definitions‘Accessibility refers to the degree to which an interactive product is accessible by as many people as possible’ (Rogers et al. 2011, p.17)

When the author is a particular authority‘Everything should be made as simple as possible, but no simpler’ Albert Einstein

Einstein has great authority – and knew a lot about complexity versus simplicity (E=mc2)

HeadingsUse them (they help the reader), make them informative“Background research” - not very informative!“Previous research on web accessibility and usability”(Some readers like only the standard headings like ‘Introduction’, ‘Methodology’)BUT Do not assume the reader has read them on the way through

may seem odd, but it is definitely true

HeadingsSo, do not follow a headingResearch on Web accessibility and usabilitywith

This area of research received little attention until the late 1990s.

Must be:Web accessibility and usability received little research attention…

Figure and tablesThey can help a reader enormouslyIt is OK to use a figure/table from a published source, if it is acknowledged

usually in the captionEach figure/table should have a clear, stand-alone captionEach figure/table must be referred to in the text

otherwise how will the reader know when to study it?

Designing figures and tables

Make sure they are sufficiently rich in information (would it be simpler to give some words?)

but not too clutteredAre axes, objects all clear?Zobel has a good section on good and poor design

http://www.amazon.com/Writing-Computer-Science-Justin-Zobel/dp/1852338024

Give figures/tables to a colleague and ask them what they mean

Example figure

Figure 5. Auditory cues ranked by importance

Allow (as much time as possible) for checking, proofing

Use spell checks, but remember they are dumb, dumb, dumbRead yourself

out loud if at all possible

Have someone else proof read if possible Remember, you will not fail an assessment for the odd spelling mistake, but you want your report to look as professional as possible

ReadabilitySmall grammatical errors are not a problemBut if they are so bad that they obscure the meaning, then they are

Sources of informationZobel Writing for Computer Sciencehttp://www.amazon.com/Writing-Computer-Science-Justin-Zobel/dp/1852338024

Strunk and White - Elements of Style

For the specifics of constructions etc (if you are not confident) - Fowler’s Modern English Usage

Mander K. (1994) Writing for Humanshttp://www.cs.york.ac.uk/tutorials/writingforhumans.html

Thimbleby, H (2008) Write now!, (in) Cairns. P & Cox, A. (eds.) Research Methods for Human-Computer Interaction, Cambridge University press, pp.196-211

Read literature critically for style - re-read papers, chapters that you found easy to read