• Search by category

  • Show all

Efficient Document Editing: A three-phase workflow

August 1, 2012

You can waste a considerable amount of time when reviewing and editing draft documents, particularly when it is being reviewed by an inexperienced team [1,2,3]. When you send a ‘raw’ text out to a team for review you can multiply the number of ours you expect to spend on a document by the number of people on the review team [2,4].

Your reviewers may also have their own writing style and poorly prepared documents (not ready for circulation) can result in heavy re-writes by the team [1,5]. This not only has the potential to waste their time but also your time navigating how best to combine additional text and possible tables/figures into the work returned by the other members of the review team [2,4,6].

I know I have my own exacting requirements when I review draft documents and also like to provide ‘training’ to the review team, explaining the choices you have made. Editorial guidance recognises that reviewers often use manuscript review as an opportunity to provide developmental feedback, particularly in collaborative or mentoring contexts [3,7]. It may seem somewhat nonsensical, but I may even add edits and comments to sections that I ask to be removed, a practice often observed in substantive peer and internal review processes [5,6]. There is such a potential for all parties to burn time [1,2]. There are few texts where I don’t provide comment of some form or another. In response, I have developed a structured approach that has served me well in providing timely reviews, consistent with recommendations from biomedical publishing authorities [2,3,8]. To be clear, I only use these techniques on documents Niche has been employed to deliver and which fit within clearly defined writing and editing services and appropriate ethical boundaries relating to contributions made to documents [9,10].

In order, the three steps include:

Research review: involves evaluating various aspects of the research including whether the literature of the field has been interpreted correctly, whether the methods used were appropriate, correct use of the methods (including any statistical analysis) and the results are clearly presented [11,12,13]. It is also important to cross reference the conclusions against the projects objectives, endpoints and whether the conclusions drawn from the results are robust [11,12].

Document structure: Addressing the flow of the document – effectively its storytelling. This tends to consider the larger structural aspects of a document. Interrogations includes:

  • Whether any additional background information should be included [12,14].
  • Background/Discussion content – is all the relevant information included, should or could sections be deleted [11,12]?
  • Is the information/data presented in the best sequence for the reader to understand it [12,14]?
  • Is the document the right length/does it meet any restrictions for the document type [11,15]?

Text editing: This includes phrasing, transitions between paragraphs, and grammar usage [1,8]. In addition, the process involves cross referencing links to tables, figures and appendices and finalising the references [11,15]. The order you address these different aspects can be down to personal preference. As you tend to be closer to document completion when you get to text editing, it can be useful to adopt a structured approach: structural components (tables and figures), punctuation and abbreviations and finally grammar [1,8,11].

This approach may not necessarily be considered as addressing the aspects of the document in order of their importance, rather they are addressed in order they are most likely to extend the review and finalisation process [2,4,6]. Clearly, all three aspects are critical to produce a high-quality document – but, rather, they are ordered according to how disruptive the changes at each phase would be to the other aspects of document development [11,12,13].

It can be difficult to coordinate larger editing teams when you are trying to adopt a considered, time efficient three-phase approach to editing [2,4]. It is far too easy to start line editing a manuscript and miss the larger fundamental problems with the research or the structure of the document [11,13]. Reviewers often get to the end of the document and find that they have made a lot of comments and conclude, “that’s enough changes for one round of editing,” and fail to address these other, larger issues [13,16]. For that reason, it can sometimes be best to identify a smaller review group who can perform a first research review edit. Only distributing to the wider team once all the kinks have been ironed out [3,4,11].

Authors are not always aware of the true status of their documents. Studies of peer review and editorial assessment indicate that external review is often required to accurately determine manuscript readiness and quality [3,13,16]. In addition to saving time and effort, the three-phase process helps authors focus on higher-order issues rather than becoming lost in line-editing corrections and expecting a manuscript to move from first draft to final version in a single revision cycle [11,15].

References

  1. Strunk W, White EB. The Elements of Style. 4th ed. New York: Longman; 2000.

  2. Lang T. How to Write, Publish, and Present in the Health Sciences. Philadelphia: ACP Press; 2010.

  3. Council of Science Editors. Scientific Style and Format. 7th ed. Reston (VA): CSE; 2006.

  4. Day RA, Gastel B. How to Write and Publish a Scientific Paper. 6th ed. Cambridge: Cambridge University Press; 2006.

  5. Hartley J. Academic writing and publishing. A Practical Handbook. (2008).

  6. Wager E, Godlee F, Jefferson T. How to Survive Peer Review. London: BMJ Books; 2002.

  7. Hames I. Peer Review and Manuscript Management in Scientific Journals. Oxford: Blackwell; 2007.

  8. Goodman NW, Edwards MB. Medical Writing: A Prescription for Clarity. 3rd ed. Cambridge: Cambridge University Press; 2006.

  9. Uniform requirements for manuscripts submitted to biomedical journals. International Committee of Medical Journal Editors. JAMA. 1997 Mar 19;277(11):927-34.

  10. Wager E. Authors, ghostwriters, and honorary authorship. Med J Aust. 2007;187(5):255-257.

  11. Moher D, Schulz KF, Altman DG; CONSORT Group. The CONSORT statement. Lancet. 2001;357(9263):1191-1194.

  12. Gopen GD, Swan JA. The science of scientific writing. Am Sci. 1990;78(6):550-558.

  13. Rennie D. Guarding the guardians: A conference on editorial peer review. JAMA. 1986;256(17):2391-2392.

  14. Hall GM. How to Write a Paper. 4th ed. London: BMJ Books; 2008.

  15. Iverson C, Christiansen S, Flanagin A, et al. AMA Manual of Style. 10th ed. Oxford: Oxford University Press; 2007.

  16. Jefferson T, Wager E, Davidoff F. Measuring the quality of editorial peer review. JAMA. 2002;287(21):2786-2790.

About the author

Tim Hardman
Managing Director
View profile
Dr Tim Hardman is Managing Director of Niche Science & Technology Ltd., a bespoke services CRO based in the UK, and a keen and occasional commentator on science, business and the process of drug development. He also serves occasionally as acting Scientific Director for the healthcare agency Phase II International, specialising in medical strategy and communication.

Social Shares

Subscribe for updates

* indicates required

Related Articles

Get our latest news and publications

Sign up to our news letter

© 2025 Niche.org.uk     All rights reserved

HomePrivacy policy Corporate Social Responsibility