Top Banner
Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)
54

Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Dec 24, 2015

Download

Documents

Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Technical Editing part 1

Laura Mellor (John Wiley)

Margaret Cooter (BMJ)

Page 2: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Workshop aims

• Ensure that Cochrane Reviews are reported as clearly, succinctly and accurately as possible

• Improve quality

• Increase accessibility

Page 3: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Plan: workshop 1

1. What is good technical editing?

2. The job of technical editors at BMJ

3. Exercise 1: Anticoagulation for heart failure in sinus rhythm

4. Editing tips

5. Exercise 2: putting the tips into practice

Page 4: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Important note on this session

• The review featured in this workshop was selected based on its length, the number of outcomes and the fact that anticoagulation is a common and well-known treatment

• We imply no criticism of the scientific rigour of the review

• We imply no criticism of the authors or the Cochrane review group responsible for the review’s publication

Also: please help us by wearing your name badges!

Page 5: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Objectives

• What do you want to get out of this workshop?

Page 6: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

What do we mean by technical editing?

For the purposes of the workshops, we define technical editing as:

• Substantive editing of text for clarity of expression

• Checking of table and other data• Applying house style (but we will not

concentrate on that aspect in these workshops)

• NOT editing that requires specific subject knowledge

Page 7: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Components of technical editing

Page 8: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Substantive editing

Data & fact

checking

House style

– for sense – -(includes grammar etc)

– for consistency –

(includes layout)– for accuracy –

-(includes references)

Page 9: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Editorial interventions

• Technical editing

• Medical editing

• Copy editing

• Language editing

• Peer review

Page 10: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Technical editing: what is the evidence?

• Wager E, Middleton P. Technical editing of research reports in biomedical journals. The Cochrane Database of Methodology Reviews 2003, Issue 1.

• “Some evidence that the overall 'package' of technical editing raises the quality of articles…”

• “The literature contains a large volume of opinion and discussion, not much evidence, and even fewer rigorous studies.”

Page 11: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

How do papers change during technical editing?

• Study of 10 papers published in BMJ (Albert 2000, unpublished data)

• “Many textual changes, some to improve readability, others to produce uniform house style”

• “Textual changes do not seem to have major impact on structural aspects”

• “Many of the major interventions seem to be made not on the paper itself, but on additional items that ‘market’ the paper to readers, ie abstracts, summary boxes”

Page 12: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Good technical editing

• Clarity

• Conciseness

• Consistency

• Accuracy

• Balance between needs of the paper and needs of the reader

Page 13: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Interaction of the components makes for a readable, accessible

product

Page 14: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Substantive editing

Data & fact

checking

House style

CLARITY

CONSIS-TENCY

ACCURACY

Page 15: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Technical editing at BMJ

“Technical editors are one of the key groups of implementers and problem solvers for

journal content.”

Page 16: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

BMJ office – production section

Page 17: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Here there be editors …

Page 18: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

…and here, the unsung heroes (technical editors)

Page 19: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Some statistics

• 51 issues a year

• 64 editorial pages per issue

• 3000 or so pages a year

• 110,000 print copies each week

• 208,000 different users access bmj.com each week

Page 20: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)
Page 21: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Review and acceptance

• 7500 articles submitted per year• 8% accepted, mostly subject to revision• 60% rejected after first read (24 hours after

submission)– Too specialised– Not new results

• We aim to reach a final decision on publication within 8 weeks of submission

Page 22: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Papers, filed by section, await editing

Page 23: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Editing a paper

• First read the backmatter

• Text

• Tables

• Figures

• Summaries

• Keeping track of where the paper is

Page 24: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Flowchart/checklist for long and short versions

Page 25: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Authors

• Email has changed dealing with authors– Queries– Proofs– “Customer care”

• Letting them know what to expect

Page 26: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

BMJ Paper 303362Technical editor: Clare Griffith; tel: 020 7383 6691; email: [email protected]: We are now posting research articles online before print publication. When you return your proofs and we have processed your changes WE WILL POST IT STRAIGHT AWAY ON bmj.comPLEASE CHECK THE PROOF CAREFULLY AS ONCE THE PAPER HAS BEEN POSTED IT IS DIFFICULT AND EXPENSIVE TO CHANGE IT——————————————————————————————————General points: Visible codes for electronic publishing (eg [t1] for tables and [f1] for figures, and <thin> for spacing in large numbers) will not appear in the final version. Alignment of tables will be improved. Footnote and mathematical symbols may not translate properly. They will be correct in the published version. Please check that all queries to author [indicated by bold square brackets] have been answered.**************************************************************************

Note to author

Page 27: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Online First

• Posting on bmj.com constitutes publication– Posted as pdf– Press released when posted

• pdfs look somewhat different from (eventual) print version

• Online First version is usually the long version, print version is abridged

Page 28: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Flowchart/checklist for Online First articles

Page 29: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Web extras

• P+ symbol indicates extra material on bmj.com– References, statistical appendices, tables,

figures, video clips– “posted as supplied by author”

Page 30: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Access web extras via bmj.com

Page 31: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Fast track

• Many submitted, few chosen – 2 submissions a day ask to be fast track– 20-30 a year considered– 10 actually published as fast track

• Topicality; linked to an event

• 10 days from submission to publication

Page 32: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Becoming a technical editor

• Characteristics:– Aptitude – determined via copy editing tests– Experience – work on scientific journals or

scientific writing– Psychological robustness – to withstand training

• Training is through “apprenticeship” – Work is revised for about 6 months

Page 33: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Continuing training

• Style meetings – make changes to, and promote awareness of, house style

• Group edits – reinforce critical thinking• Feedback for quality control:

– Proofreaders’ changes– Spot checks, especially of key areas (abstract,

summary)– “On Yer Toes” – circulate narrowly-averted

disasters (on proofs) and errors that get into print

Page 34: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Cochrane principles

Collaboration

Building on enthusiasm

Avoiding duplication

Minimising bias

Keeping up to date

Striving for relevance

Promoting access

Ensuring quality

Continuity

Enabling wide participation

Page 35: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

The Cochrane Handbook

“Cochrane reviews should be easy to…understand by someone with a basic sense of the topic who may not

necessarily be an expert in the area.”

“Some explanation of terms and concepts is likely to be helpful…too much explanation can detract from the readability of a review. Simplicity and clarity are also

vital to readability.”

“The readability of Cochrane reviews should be comparable to that of a well-written article in a

general medical journal.”

Page 36: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Haynes RB. “Of studies, syntheses, synopses, and systems: the “4S” evolution of services for finding current best evidence.” ACP Journal Club (2001 March-April; 134(2):A11-3.)

Where does Cochrane fit in the EBM literature?

Page 37: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Exercise 1: Anticoagulation for heart failure in sinus rhythm

• What works and what doesn’t? What needs changing?

• What’s being said? Is the message coming through?

• Is the meaning clear and unambiguous? Are the right words used?

• Are there too many words? Are the sentences too long and complicated?

Page 38: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Numbers: tip 1

• Where raw numbers and percentages are given, make sure they agree

• Example:

“More than 60% (40/79) used the guidance correctly.”

• Either the percentage or the raw numbers here are wrong

Page 39: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Numbers: tip 2

• Check that all study participants have been accounted for

• Example

“352 participants (treatment a = 115, treatment b = 117, control = 121)

Page 40: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Numbers: tip 3

Query blank fields in tables, enter ‘n/a’ or similar if you know they are supposed be blank

Page 41: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Summary of data available for neurological

signs, CT scans and EEG results

Trial EEG Normal CT Scan Normal

Neurol Exam normal

Brodie 1995 A CBZ = 30/65 (46%), LTG = 32/69 (46%), missing = 2 (CBZ = 1, LTG = 1)

CBZ = 44/49 (90%), LTG = 38/45 (84%), missing = 42 (CBZ = 17, LTG = 25)

CBZ = 5/66 (8%), LTG = 8/70 (11%), missing = 0

Nieto-Barrera 2001

NA NA NA

Page 42: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Numbers: tip 4

• Check percentages add up to 100

• Check percentages again after rounding up or down

Page 43: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Percentages over 100

Grade A 20/30 67%

Grade B 5/30 17%

Grade C 5/30 17%

= 101%

Page 44: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Numbers: tip 5

• Check consistency within the review• Example:Abstract “A significant reduction in use of

rescue medication was observed in the treatment group compared with the control group (p = 0.002)”

Results “A significant reduction in use of rescue medication was observed in the treatment group compared with the control group (p = 0.0002)”

Page 45: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 1 – noun strings

• Found in newspaper headlines: Outback murder courtroom drama

• “Spell it out” to avoid ambiguity: Heart valve durability evaluation procedures

becomesProcedures to evaluate the durability of heart

valves

Page 46: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 2 – antecedents

• Watch out for “they”, “this”, “those” – and especially “it”

• Check that the antecedent is clear: This is especially problematic with “this”.

Does it refer to a general concept, perhaps in the previous sentence? This will need to be stated clearly.

Page 47: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 3 – unnecessary words

• Are these little words really needed?– Both, usually, very– In addition, furthermore– However– Respectively

• “It is … that” phrases can usually be removed:

“It is likely that it will rain” becomes “It may rain.”

Page 48: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 4 – active or passive?

• Readers understand better when they read active sentences– The verb is nearer the start of the sentence

• Active may require use of the first person– “The aim of our study was to investigate...”

becomes “We investigated...”

Page 49: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 5 – inflated language?

• For readability and getting the message across, use the simple word or phrase– Endeavour (try); commence (start); requested (asked);

terminate (end)

• Verbosity is a waste of words:“It is possible that this will happen” becomes “This may

happen”

• Avoid cliches like the plague

Page 50: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Text tip 6 – “there is”

• A weak construction

• Can usually be avoided: There have been no serious adverse

events attributable to the vaccines.becomes

No serious adverse events attributable to the vaccines have occurred.

Page 51: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Pitfalls in copy editing

• Falling asleep at the screen

• Losing the original version

• Too much else to think about at the moment

Maeve O’Connor, author of How to Copyedit Scientific Books and Journals

Page 52: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Exercise 2: putting the tips into practice

• Edit in groups

• Note each change on a post-it note (one change per note)

• Do your changes improve clarity, conciseness, consistency, accuracy?

Page 53: Technical Editing part 1 Laura Mellor (John Wiley) Margaret Cooter (BMJ)

Plan: workshop 2

• Focus on format and summarising

• Format: thinking about order of presenting the information

• Summarising: shortening the text and retaining the key points