Writing It Right

NACCQ 2007NACCQ 2007

Research Workshop: Research Workshop: Writing it Right! Writing it Right!

Clare Atkins

School of Business & Computer Technology

Nelson Marlborough Institute of Technology

Research is performed in order to be used, and used by somebody else.

Essence of good academic writing is easy communication Understandable :

Lack of - jargon, abbreviations, obscure words

Unambiguous :

clear, meaningful, correct use of words

Structured :

creates a straightforward signposted journey

Readable:

engages reader, gives them what they expect, reduces ‘noise’ as much as possible, doesn’t make reader work too hard

OverviewOverview

Building the Foundations Making an impact Improving your style Improving your structure

Watson, G. (1987) Writing a thesis – a guide to long essays and dissertations. Addison Wesley Longman Inc, New

York.

Building the FoundationsBuilding the Foundations

So you want to write good?…!

We can divide up this advice into three

HEAPS

Reading Writing Editing

What to read?

What to look for?

What to learn?

What to write?

How to start?

How to write?

How to edit?

When to edit?

When to stop?

“Writing begins in freedom and ends in discipline.”

Heaps of readingHeaps of reading

What to read?Anything! (not just for content) but alsoJournals/conferences you want to write for…Articles/books you are interested in

What to look for?Writing that you enjoy readingWriting that makes ideas clearWriting that seems to flowWriting that is easy to read (and all the opposites!)

What to learn?What works and what doesn’t!How to pay attention to the mechanics of good writing

Heaps of writingHeaps of writing

“Writing is writing – not preparing to write”

What to write?Anything! Practice, practice, practice…..Don’t wait for the right topic to write a masterpiece…..

How to start?Warm-up with free-writing (activity)

But do have something to say and know what it is you want to say!

Articulate your main idea clearly (nutshelling) (activity )

Brainstorming – organise the structure of your ideas“What I really mean is……” sessions

How to write?Write then revise, rather than revise and write.

(avoid Perfect Draft Syndrome!)Not always from the beginning….start at the end?

Heaps of editingHeaps of editing

Why?: to make your work simpler and clearer (more readable)

Ask …. do I really need that many words? is that the right word? (effect or affect?)is that the best word? (use or utilise?)is that sentence needed/too long/meaningful?do I really need to repeat that?does that really fit under this heading?

Read it aloud to someone else or yourself (proofreading too!)

When?After each draft (not after each word or sentence!)Make each edit for a particular purpose

When to stop?Put it away for 24 hours, then re-read and do final edit. (Activity)

“Most good thoughts are afterthoughts.”

Making an impactMaking an impact

or or

Going Fishing…..Going Fishing…..

Your work needs to have baited hooks! Things that will entice the reader to read

on. There are some obvious hooks to bait…..

Making an impact or ‘Going Fishing’Making an impact or ‘Going Fishing’

Hook No 1 - The title:

Encapsulates the topicIs clear and understandableDoes actually relate to the topic!Is a reasonable lengthEncourages you to read the paper……(activity)

Now do better!

Write a title for your paper! Use no more than 12 words.


Hook No 2 – the abstract

Is an advertisement for the paperIs not an introductionEncapsulates the paper in five or six sentencesShould clearly state the problemShould clearly state what you didShould clearly state what the results wereShould allow a reader to gain an overview of the entire paper just from reading the abstract

A well written abstract is a well baited hook!

Write it first – then re-write it last

Ben-Ari, Mordechai (2000). How to get a good review. SIGCSE Bulletin Volume 32. No 2 pp4-5


Hook No 3 - The first sentence

Needs to be clear and relevantNeeds to engage the readerNeeds to be the right length (20-26 words?)Sets the tone for the whole paper

Shouldn’t be a clichéShouldn’t be a generalisationShouldn’t be boring Can be provocative

(Activity)


Hook No 4 The problem statement (hypothesis)

• A very clear statement of the problem/hypothesis• Articulating it well is the key to the success of the whole paper• Should be reflected in the title• Should be referred to throughout the work

• Use it as a reminder when editing • (e.g. does this increase the readers’ understanding or

knowledge of the problem as expressed in my problem statement?)

• Is probably the most important sentence (and most difficult!)• Often the last sentence (or paragraph) of the Introduction

(activity)


Hook No 5 - The final sentence

This is a hook of a different kind. This is the reward, the after dinner mint!

After reading the final sentence, the reader should be left with a feeling of completeness, satisfaction and closure…..

or

…..very occasionally you can get away with a thought-provoking question…..

When you read, learn to savour the last sentence! How does it leave you? Does it entice you to go back and re-read? Does it

leave you thinking?

Improving your styleImproving your style

Style is very individual but here are some useful tips…


Experiment with sentence lengthWhen sentences are all the same length, reading them becomes monotonous. Vary their length. Keep your readers awake!

Experiment with active and passive voiceAcademic writing often uses the passive voice – this can complicate the expression of an idea and obscure the meaning. Experiment with using the active voice.

Avoid generalisations and cliches“Nobody these days can live without the Internet….”“ Information Technology has changed all our lives….”

Avoid overuse of acronyms“ In the IS/IT area the use of a SDLC methodolgy, particularly when building an RDBMS, is not usually a part of TQM for SMEs…..


…..and some more!

Avoid paragraphs that are too long or too shortShould be appropriate to the topic but generally 1 page is too long and 1 sentence is too short.

One paragraph – one topicEach paragraph should be concerned with just one topic unless it is a summary (in which case the summary is the topic).

Look to create flow from one paragraph to anotherReading is much easier if one paragraph flows on to the next. You can achieve this by ensuring that the last sentence of one paragraph refers to the first of the next (or vice versa)

but wait…..


………..there’s more!

Structure of paragraphs is important:Make statement at beginning and then support it

ORMake lead-in arguments and finish with statement

Avoid too many bulleted listsThey are useful occasionally but interrupt the reading flow. Too many tables (or too large tables) can do the same thing

Look out for grammatical errors and problemsParticularly with punctuation, syntax errors and use of inappropriate words (activity)

Work out your audience and write for them…. Should you use “I” or “the author”…?

Improving your structureImproving your structure

There are three stages to scholarly authorship. The first is finding something to say; the second is arranging it; the third expressing it (inventio,

dispositio and elocutio). …writing is not just having something to say and saying it. There is a middle

phase.. “


“Don’t let fuzzy thoughts become fuzzy words. And if thinking fuzzily helps you get started, return to that initially fuzzy first draft and revise it for clarity” (and for structure).

A paper should answer the question plainly implied by your title and bluntly posed in your problem statement. Beginning with a specific question it ends with an answer to it.

“It is not meant to represent the range of your mental interests….it should not begin with Plato and end with Wittgenstein just because you have something interesting to say about them both.”


“How you arrange your writing is as important as whatever it is that you are saying. There is little point in spending a long time revising and correcting your style if there is no overall sense of purpose in what you write.”

Overall generic structure of piece of academic writing

IntroductionBackgroundResearch Methodology/ProcessWhat you actually didWhat you discoveredWhat your results meanWhat you might do nextSummary and concluding remarks

See handout for more details…..

Some final wordsSome final words

Take your writing seriously and practise it just like any other skill

Make friends with a dictionary and a thesaurus

Read your writing aloud – often!

Share your writing with others – get together, ask for opinions

Submit as much as you can for external review – take the criticisms as free advice!

and remember

The eThe essence of good academic ssence of good academic writing is easy communicationwriting is easy communication

Understandable

Unambiguous

Structured

Readable

ActivitiesActivities

Activity 1 Free-WritingActivity 1 Free-Writing

The purpose of free-writing is to loosen you up and warm you up for some serious writing.What you write is much less important than the fact that you are writing.

Back

Pick up a pen/pencil and a pad of paper

When I say “Go” - Write for 5 minutes about your topic without stopping ….If you can’t think of what to write, just write “blah blah blah” until you think of words related to your topic.

You don’t have to write sentences, or correct grammar or correct spelling – JUST WRITE!

GO! STOP!

Activity 2 - Knowing what to sayActivity 2 - Knowing what to say

Nutshelling

Nutshelling is a technique for trying to explain a complicated idea in as brief a way as possible.

It requires you to create ONE sentence which begins, “In a nutshell……”

Lets try it!

“In a nutshell the main problem with my writing

is……………………………………………………………………………..”

Activity 2 - Knowing what to sayActivity 2 - Knowing what to say

“How can I know what I think until I see what I say?”

This may be an exaggeration but it holds a useful idea – that • articulating your ideas, • putting them into words, • trying to communicate with another person,

can be a useful way of exploring what you want to say about a topic.

You have 2 minutes to think about what you would say to explain your topic to someone…….

You have 2 minutes each to explain your topic to the person sitting next to you…. (in turns). Begin by saying “In a nutshell my topic is…”

Now the real test!You each have 1 minute to recount to the group your partner’s topic!

Back

Activity 3 Editing Activity 3 Editing

“Writing is largely re-writing. All scholarly prose improves with revision”

The purpose of editing is to sharpen up and clarify your writing. Often you can cut your word count considerably. You should concentrate on making your writing easy to follow and interesting to read.

Back

Take 5 mins to revise this paragraph….

“Objective considerations of contemporary phenomena compel the conclusion that success or failure in competitive activities exhibits no tendency to be commensurate with innate capacity, but that a considerable element of the unpredictable must invariably be taken into account.”

(original)

Activity 4 Titles - Activity 4 Titles -

1. “Antidote for madness: What every grammar school student should know and understand but which very few of our best educated people either know or understand.”

2. “Remarks on the Quantum-Gravity effects of "Bean Pole" diversification in Mononucleosis patients in Developing Countries under Economic Conditions Prevalent during the Second half of the Twentieth Century, and Related Papers: a Summary “

3. “Training students to intervene in Information Systems inherently involves organisational and technology skill acquisition”

4. “Quality and Rigour of Action Research in Information Systems”

5. “What’s in a Name? Conceptual Issues in Defining Electronic Commerce”

6. “Identifying and Classifying Processes (traditional and soft factors) that support COTS Component Selection: A case study.”

7. “Nice models but where’s the business?”

8. “Experts, expertise and Professional’s explanations.”

9. “The process of eliciting Information Requirement in Executive Information Systems from the perspective of the executive as an expert”

10. “The nature of information”

11. “Critical appraisal guidelines for single case study research.”Which would you read? Marks out of 10, Justify!

Activity 4 Titles - Activity 4 Titles - Back

My favourite so far:

Assessment of the quality of copulation partners in the monogamous bearded tit

Activity 5 - First sentenceActivity 5 - First sentence

1. Write at least 3 alternative first sentences for your topic.

2. Choose the best and decide why you prefer it3. Refine it if you can (i.e. edit it!)

Go4. Exchange it with a partner5. Edit your partner’s sentence Go

6. Compare notes! – is it an improvement?

Back

Activity 6 – Problem statementActivity 6 – Problem statement

This is a form of ‘nutshelling’ – the one sentence summary.

Imagine you have spent half an hour explaining your work to an audience. What is the one thing you really want them to remember in 48 hours time?

Write that one thing as one sentence…

Back

NOW!Read that sentence out to the group, followed by your title.Do they match?

Spend a few minutes, revising your title and your ‘one sentence’.

Could your one sentence stand as the problem statement?

Activity 7 – Grammar and Activity 7 – Grammar and PunctuationPunctuation

What, if anything, is wrong with these ?

The design of a web-page can effect it’s marketing potential.

Frodo killed the orc with a sword

I am very adaptable, will eat anything and am very fond of children.

Woman without her man is nothing.

Back

The design of a web-page can affect its marketing potential.The design can affect its effectiveness

With his sword, Frodo killed the orc (or did the orc have the sword?)

I am very adaptable and will eat anything. I am also very fond of children.

I am very adaptable. I will eat anything. I am very fond of children.

Woman without her man, is nothing ORWoman: without her, man is nothing.

OriginalOriginal - George Orwell - George Orwell Back

“I am going to translate a passage of good English into modern English of the worst sort.

Here is a well-known verse from Ecclesiastes:I returned and saw under the sun that the race is not to the

swift, nor the battle to the strong, neither yet bread to the wise, nor yet riches to men of understanding, nor yet favour to men of skill; but time and chance happeneth to them all.

Here it is in modern English:Objective considerations of contemporary phenomena compel

the conclusion that success or failure in competitive activities exhibits no tendency to be commensurate with innate capacity, but that a considerable element of the unpredictable must invariably be taken into account.”

George Orwell, Politics and the English Language (1946) in Shooting an Elephant (1950) quoted in Watson (1989).