Technical Editing part 1

Download Report

Transcript Technical Editing part 1

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

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

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!

Objectives

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

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

Components of technical editing

House style Substantive editing

– for sense –

-(includes grammar etc)

for consistency –

(includes layout) Data & fact checking

– for accuracy –

-(includes references)

Editorial interventions

• Technical editing • Medical editing • Copy editing • Language editing • Peer review

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.

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”

Good technical editing

• Clarity • Conciseness • Consistency • Accuracy • Balance between needs of the paper and needs of the reader

Interaction of the components makes for a readable, accessible product

Substantive editing

CLARITY

House style

CONSIS TENCY ACCURACY

Data & fact checking

Technical editing at BMJ “Technical editors are one of the key groups of implementers and problem solvers for journal content.”

BMJ office – production section

Here there be editors …

…and here, the unsung heroes (technical editors)

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

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

Papers, filed by section, await editing

Editing a paper

• First read the backmatter • Text • Tables • Figures • Summaries • Keeping track of where the paper is

Flowchart/checklist for long and short versions

Authors

• Email has changed dealing with authors – Queries – Proofs – “Customer care” • Letting them know what to expect

Note to author

BMJ Paper 303362 Technical editor: Clare Griffith; tel: 020 7383 6691; email: [email protected]

NB: 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.com

PLEASE 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 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.

**************************************************************************

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

Flowchart/checklist for Online First articles

Web extras

• P+ symbol indicates extra material on bmj.com

– References, statistical appendices, tables, figures, video clips – “posted as supplied by author”

Access web extras via bmj.com

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

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

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

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

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 helpfu l…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.”

Where does Cochrane fit in the EBM literature?

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.)

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?

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

Numbers: tip 2

• Check that all study participants have been accounted for • Example “352 participants (treatment a = 115, treatment b = 117, control = 121)

Numbers: tip 3

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

Summary of data available for neurological signs, CT scans and EEG results

Trial

Nieto-Barrera 2001

EEG Normal

NA NA

CT Scan 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)

Neurol Exam normal

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

Numbers: tip 4

• Check percentages add up to 100 • Check percentages again after rounding up or down

Percentages over 100

Grade A Grade B Grade C 20/30 5/30 5/30 67% 17% 17% = 101%

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) ”

Text tip 1 – noun strings

• Found in newspaper headlines: Outback murder courtroom drama • “Spell it out” to avoid ambiguity: Heart valve durability evaluation procedures becomes Procedures to evaluate the durability of heart valves

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.

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.”

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...”

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

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.

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

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?

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

Thank you for your attention

[email protected]

[email protected]