A Recipe Gone Haywire (ARGH)

Grants & Funding / Writing & Publishing

I don’t have a lot of time to cook, so I am always looking for new sources of easy and at least somewhat healthy recipes. Recently, I bought a cookbook titled Mediterranean Every Day (MED) by Sheela Prakash. This cookbook is great because the recipes usually have a short list of ingredients, and most dishes don’t require a lot of time or prep to prepare. Recently I made a pasta dish from MED. The dish used pesto, charred radicchio, and penne pasta or similar. The cool thing is that the pesto part of the dish has many variations depending on the types of greens and nuts you like or have on hand.  I followed the instructions in MED and used pine nuts, basil, and jarlberg (PBJ) as the main ingredients for the pesto. I toasted the pine nuts, cut the Jarlsberg, then put the PBJ into a food processor along with a little garlic, salt, and lemon juice. Once the PBJ turned into a paste I mixed it with the pasta. Other variations include pine nuts, endive, and edam cheese (PEE), walnuts, endive, and edam (WEE) or cashews, rosemary, and parmesan (CRP) which sounds promising.  Although many combinations work well, using pine nuts, Oaxaca cheese, and okra might be super mushy and taste like, well you get the point. Given all the variations and flexibility, this recipe from MED has become one of my “go to” dishes for a quick week-night dinner.

I don’t know if the above paragraph made my point so in the spirit of clarity, I’ll spell it out. I’m not a big fan of acronyms. In fact, I think acronyms are a good way to put a barrier between you and your reader/reviewer (see further reading below for more). Many academic writers like to use acronyms to save space. Unfortunately, unless the acronym is very well known (think PBS for phosphate buffered saline) the onus is on the reader to remember the acronym. Now that we have smart phones to remember for us, keeping an acronym stored in our puny non-digital domes has become, at least for me, more difficult.

When I am reading a paper or grant and I run into an unfamiliar acronym, I am faced with two choices. Either go back and find the definition of the acronym, which I clearly blew past, or keep reading and not be sure what the acronym means. Sometimes when I go back to find the definition I can’t – which is annoying, time consuming, and I end up moving on anyway. Here’s where the barrier comes in. Reading an acronym that is undefined is like reading a word that is undefined. Your mind skips over it and you miss the deeper meaning. In the recipe above, when you read the acronym MED did you think Mediterranean cooking or did you think something else like medicine? Maybe you didn’t think anything and your brain just glossed over it. You risk losing clarity with unnecessary acronyms.

Sometimes an acronym is like an acronym or word you already know. Does PBJ and garlic sound like a good combo? It’s very difficult to read the above recipe and not think about one of my favorite sandwiches, peanut butter and jelly. You might think this would never happen, but I recently read a grant where one of the frequently used acronyms also spelled out a familiar signal transduction factor. This similarity was distracting and I had to keep mentally reminding myself of the acronym’s meaning.

Of course, sometimes an acronym may spell out a different word entirely, and I’m sure as an astute writer you would never let that happen. The word could be in a different language, though, giving your multilingual readers a good laugh or gasp. I wish I could say that’s my problem but unfortunately, I only speak and write in one language.

If you are to avoid “unnecessary” acronyms, this begs the question as to which acronyms are necessary or at least acceptable. As a reminder, the general rule for using an acronym is that you should use the word or phrase at least three times to justify making this abbreviation. I’m not sure where this rule originated, but it seems reasonable and can be found in many writing/grammar type websites. Assuming you’ve heeded the above recommendation and feel the need to proceed with an acronym or two, then consider the following.  If the acronym is well known in your field, and the paper/grant is directed to those in your field (ie a specialty journal) then you are probably fine. Alternatively, if the name doesn’t mean anything to the reader anyway, you are probably fine as long as the acronym doesn’t form another familiar word. For example, I used to publish on heparan sulfate proteoglycans and glycosaminoglycans, fondly known as HSPGs or HS GAGs. If I was writing for my matrix-loving colleagues, I would go ahead and use these acronyms. If I was writing for a general audience, I’d consider using HSPG as long as I’m using it frequently and the context helps remind the reader of the definition. I might skip the GAG abbreviation, for fear of conjuring memories of a regrettable beer-vodka mix, bad burger, or both. The same concept applies to lengthy chemical names or a chemical combo/molecular hybrid, etc especially if this is something you are mentioning frequently. If you have the freedom to make up an acronym for a new compound or biologic that you’ve derived, try to generate an acronym/abbreviation that serves as a reminder to the function of that compound.

In the end, when it comes to acronyms, less is more. And with that, I say TTFN!

Further reading

An Abbreviations FAQ – blog on using abbreviations, APA style

Avoiding Barriers Between your Work and your Reviewer – blog post by yours truly on clarity in grant writing

Make It About the Science

Writing & Publishing

Always percolating below the surface of biomedical science is the ever-important quest to distinguish ourselves and our research through the art of publishing. Inevitably our efforts lead us to the same gateway: passing muster with the dreaded Reviewer, who lurks in the shadow world of anonymity. Fans of Lord of the Rings might compare navigating peer review to Frodo and company attempting the Redhorn Pass that ostensibly provided courageous middle-earthers a way over the treacherous peaks of Caradhras – with the caveat that peer review is much harder. After all, traversing the sheer slopes of a frozen mountain is good honest danger, the kind that advertises itself well ahead of time and therefore is unambiguous. Peer review is anything but. The process is fraught with ambiguity. You never really know who will review your paper. Even if you did, you cannot gauge their frame of mind when they accept the assignment or finally sit down to review what took you weeks and months to prepare.  So, we try to stack the deck in our favor the best we can. We demonstrate fervor for things like rigor, reproducibility, readability, and grasping the literature of the day. We practice staying on message (difficult for those of us who are perpetually over-caffeinated) and writing clearly and succinctly (difficult for everybody, with or without caffeine). Well, so far so good. A seasoned reviewer is used to forgiving honest mistakes – things like forgetting a citation, abusing the use of commas, or sticking a p-value in the middle of a sentence. No harm, no foul, and we move on together.

There are other tendencies or practices, however, that are a little less forgiving and apt to cause trouble for intrepid investigators trying to make it to print. When I edit a paper for a colleague or mentee, what gets caught in my gizzard every time are the unnecessary, unforced errors – the kind that people walk into willingly. These include the category of what I like to call “chest thumping”:  a form of self-assertion that makes a paper less about the science and more about the scientists. Sometimes, in the attempt to distinguish our work or emphasize our innovative ideas, we step into certain human traps, the kind that ornery reviewers are keen to monitor.  Here are some examples:

“In our paper, we show for the first time that A leads to B”

No one has investigated whether A leads to B, and we do so here for the first time”

“Our approach is the first to use A to show B”

… and so on. Here’s the problem. Claiming to be either first or better in science is always tainted with at least a hint of subjectivity, especially when you’re trying to climb the proverbial ladder. Also, to state the ridiculously obvious, you don’t know what you don’t know. Don’t kid yourself – everything is open to interpretation. Chances are whatever you did, someone did a version of it before you. Murphy’s law mandates that this someone (or perhaps their mentor or protégé) will be your reviewer. At best, you might have gotten the facts wrong. At worst, you got the facts wrong and insulted the reviewer. The point is, neither is necessary – this is what we mean by “unforced errors”.  If indeed the approach and findings are novel and important, the experts whose respect and attention you want will recognize your achievement. No need to tout yourself and risk alienating an otherwise benign reviewer. Finally, if in fact you have done something better or improved upon a method, people will adopt your approach and cite your work, including those whose methods you improved.  This is a far bigger compliment than you could ever give yourself.  By the way, working in the perfunctory and now cliché “to our knowledge” disclaimer doesn’t really help. Everyone assumes you have the latest, greatest knowledge before you write the paper. No need to draw attention to the possibility that you might not.

Why am I making such a fuss? Regardless of who did what, rigorous, novel, and innovative results speak for themselves and stand the test of time – and will define the cutting edge until a more sensitive approach comes along. That’s part of the game we play. By staying in the background and letting your results stand on their own, you reduce the chances of inciting the reviewer’s personal ire and giving them the opportunity to bring you down a couple of notches. Consistent with the theme of these musings, consider avoiding statements like:

Dr. X showed A while Dr. Y showed B.”

“Dr. X and Dr. Y showed A, Dr. Z showed B, and Drs. X, Y, and Z showed C.”

You see the trend? The writing becomes burdensome very quickly, trying to layer in who did what.  What stands out is the litany of names and dates, not the important facts.  Though this kind of citation is well-intentioned, once again you are bound to leave someone out, thus bruising egos and hurting your chances for a quick acceptance.  I urge my trainees and colleagues simply to state the facts with appropriate citations:

“A leads to B (X et al., 2010; Y et al., 2015,), while B leads to C (Z et al., 2020).”

When you arrive at the discussion of your paper, your contribution will flow that much more easily from prior work:

“A leads to B (X et al., 2010), while our results indicate C and D.”

In this context, there is absolutely nothing wrong with using “our results” because you are simply drawing attention to the current presentation – not tooting your own horn.

Look, writing papers is hard work, just like the science that goes into them. As new information piles up daily around us, ironically what we can be certain of becomes harder to discern. By keeping your referencing impersonal, you minimize the risk of losing your message in needless offense while emphasizing what is most important – namely, that A leads to B.

Further reading/listening:

Don’t Wait Until You’re Motivated to Write. Take Small Actions!

Writing Science in Plain English: Clarity Rules

The Write Rules

Writing Science in Plain English: Clarity Rules

Book Reviews / Writing & Publishing

As one might expect from the title, Writing Science in Plain English is clear, concise, and very easy to understand. In fact, it’s one of the best books on writing I’ve come across. If you only read one book on science writing, make it this one.

In short, digestible chapters filled with examples and exercises, author Anne E. Greene demonstrates how to tell a clear and engaging story with active voice, strong verbs, and thoughtful word choices. She also spends a lot of time on how to arrange paragraphs and report information in the most understandable ways. Chapter 7 is particularly valuable. When writing, authors can often forget that the data and ideas they’ve been working with for months or years is new to readers. Understanding how humans process written information—we best understand something when old information comes at the beginning of a sentence while new information is placed at the end—has helped me reframe some of my writing to lead readers through the steps to my conclusions. The many examples of good and poor placement of information in a sentence vividly illustrate the point.

In addition to Greene’s deconstructions of why an impenetrable piece of writing is so difficult to read, I most appreciated the short, to the point explanations for why each piece of advice she dispenses clarifies writing. For example, in Chapter 3, she explains that abstract nouns like “manifestations” acting as subjects in a sentence can cause confusion for the reader because they “tend to nudge the characters in a sentence into supporting roles such as modifiers and objects of prepositions where readers are likely to miss them.” Rather than handing down rules from on high, Greene tells us why the rules matter.

At less than 100 pages, Writing Science in Plain English can be read in a couple of hours, but also deserves a place on any scientist’s bookshelf to reference again and again.

More Resources

The Guiding Principle in Scientific Writing

Using Content-Lexical Ties To Connect Ideas in Writing

A Smorgasbord of Grant Writing Pointers with a Side of Wit

The Guiding Principle in Scientific Writing

Writing & Publishing

Many scientific authors think that effective writing is based on a set of rules, such as proper grammar or word usage. But writing well is not simply about following rules. Writing well is about using a collection of skills and principles to write in a way that engages and informs readers.

Although many principles influence scientific writing, they are all led by one guiding principle: make the reader’s job easy.

This principle might sound simple. But making the reader’s job easy is hard. You need to craft a compelling story that engages readers. You need to select relevant content and structure it in a way that supports the story. You need to use clear language that your audience can easily understand. And you need to do all these things while ensuring the accuracy and integrity of the science. This is hard work.

What can you do to make your job easier?

Consider your audience

One important thing you can do is consider your audience. And not only who you think will read your work but also who you want to read your work. In a world with growing interdisciplinary research and declining scientific literacy, we need to write in a way that reaches a broader audience.

Keep it simple

Aim for simplicity in your writing. Write like you are talking to a stranger in an elevator. Break down complex ideas and apply plain language principles. Simplifying concepts and text is not about dumbing down ideas or language. It’s about communicating clearly and effectively.

Seek feedback

Enlist help with your writing. We all face the curse of knowledge—unknowingly assuming that our readers know what we know. In this way, we might unintentionally leave out information that is important for readers to understand. By working with a professional editor, asking colleagues to review your writing, or even asking friends and family to read your work, you can ensure that your writing is easy to understand.

Get training

Most scientific authors have had little—or even no—formal training in writing. But to write well, you need skills to help you get control of your writing. Read books on writing, everything from classic books that cover the fundamentals to books written specifically for scientific authors. Work with a writing coach. Participate in classes and workshops. Attend seminars. Take advantage of every opportunity you can to learn.

Commit to practicing

As you learn new skills, commit to practicing them. If you learn several things at once, pick one skill to focus on for a few weeks, and then pick another skill to practice for a few weeks. Only through diligent practice can you change your habits to improve your writing.

During the process, remember to be patient with yourself. Writing well takes time and effort. But small changes over time lead to big results.

The author offers editing, training, and coaching in scientific writing.

More Resources

A Lesson Learned the Hard Way

Avoiding Barriers Between Your Work and Your Reviewer

Friendly Advice from Your NIH Grant Reviewer

Becoming a More Productive Writer

Productivity / Writing & Publishing

#AcademicTwitter:

I used to be a horrible scientific writer. I was paralyzed by writing anxiety & it took me FOREVER to write papers. Last year I published 14 scientific articles (8 first, 2 second, 2 senior-author) & 2 book chapters.

A thread ⬇️  on how I became more productive:

1. Figure out when you write best & block out that time on your calendar.

I write best in the morning. Unless unavoidable, I do not take meetings in the morning. Mornings are my time to read, write, & think. I write every single day, Monday-Friday. Even if just 30 minutes.

Every Friday, I do a brain dump of what tasks I need to complete for the following week. I block off my calendar with writing times & what I will focus on during those times (e.g., 8-10am is specific aims). I try to be realistic about what I can accomplish during a given time.

This helps organize what I need to do for the following week so I start each Monday with a plan in place. Life happens and it doesn’t always work exactly the way I put it in my calendar, but it works a lot better for me than not having a plan at all.

I set my alarm to write for the designated time. Once the alarm goes off (usually a 30 or 60 minute writing block), I get up and go on a 5- or 10-minute walk. Helps me get my steps in, feel refreshed, clears my head, and I’m ready to come back and get my writing done again.

There are days that I am tired & have no motivation to write. On those days, I focus my energies on writing tasks that don’t require intellectual jumping jacks – getting title pages ready, working on tables, inserting citations. But I make progress, however small, most days.

Someone responded and summarized #1 beautifully: Block, protect, and never surrender!

2. Create an outline.

This is fairly controversial but for me, especially when I first started writing, having an outline was key. Once I knew *what* I wanted to write, it was a lot easier to sit down & do it. I use an outlining tool called Inspiration that I like.

3. Turn off your email, your phone, and anything else distracting.

Get away from anything that distracts you. I put my phone on silent, log out of social media and email (those pings really get me), and put on soft music. Gets me in my groove.

4. Ignore your inner perfectionist.

During your writing time, don’t worry about grammar or making it perfect. That is what editing is for. I tell my students to name their 1st drafts (Shitty Draft_version 0) to take the pressure off them that the first draft has to be perfect.

5. Edit, Edit, Edit.

After you have a draft, check your flow & clarity. If you hesitate on a section, revise it. If you can’t understand what you were trying to say, no one else can either. I often revise a manuscript at least 3-5 times before I send to anyone else for review.

6. Get feedback.

I’m a firm believer that papers are improved by critical feedback from collaborators. My collaborators often have different expertise & provide important insights. I have never written a paper by myself and have no plans to (co-authors are common in my field).

7. Consider creating a writing group.

If you don’t feel comfortable sending your paper to your collaborators or mentor(s) without additional feedback, consider creating a writing group with your peers. You can take turns reviewing each other’s work & it is beneficial for all.

8. Read, read, & read.

Read manuscripts in your field which will keep you up to date on literature & help you identify new ways to write. Also read outside of your field – books, magazines, & newspapers. Exposure to new ideas can spark creativity & new insights. I read a LOT!

I am not suggesting that these strategies work for everyone. I recognize we all have competing demands & others may have less resources & protected time. This is not an exhaustive list of what can work. I am sharing what has worked for me, in hopes that it can help someone else.

Importantly, I need to acknowledge that I did not write alone. I have an incredible team in the #CardelLabGroup that work incredibly hard and are very productive writers. I have the best collaborators who provide critical feedback. And I have benefited from exceptional mentoring.

I also want to add: persistence is key.

Last year, I got a manuscript accepted at a really good journal after EIGHT submissions elsewhere. I also got one paper accepted with no revisions (!!!). Recently, I got 2 manuscript rejections in one day! The rollercoaster of academia Woman shrugging.

Originally featured on my Twitter @MichelleCardel  September 15, 2020.
More academic writing tips:

Recipe for Hosting a Manuscript Sprint: Harness the power of peer accountability and review to get a manuscript out the door in 6-8 weeks.

You Need a Shut Up and Write Group Like You Need to Eat: How to start your own writing group.

Edge Writing Resources Roundup: Popular writing resources and advice to write better.

More Resources

Five Things that Help Me Write

Tune Your When, How Much, and What in your Days

One-Minute Writing Repairs

Writing & Publishing

Writing guru, fledgling medical editor, former freshman comp teacher, and Edge blogger Rebecca Helton offers bite-sized tips to improve your writing. Small adjustments can make big differences in clarity and style. We’ve rounded up links to the related posts below:

Correcting Comparisons

“Compared to” can’t replace the simpler, clearer “than.” Here’s why.

Comprise vs. Compose

“Comprised of” should never exist in formal writing. Learn how to use the comprise/compose pair accurately.

Don’t Dangle Your Modifiers Off a Cliff

Modifiers provide important detail, but can easily wander off the cliff when used incorrectly. See examples of dangling and secure modifiers.

Energize Your Words with Active Voice

The use of active voice improves even science writing. Sentences get shorter, actions clearer, and the reader more engaged.

Readability Scores

Tips for improving the readability of your writing for all audiences.

Additional Resources:

Writing in Academia: An Interview with Helen Sword

Practical Writing Advice from a Writing Teacher

Three Tips for Writing to Non-Specialists

Three Tips for Writing to Non-Specialists

Writing & Publishing

One evening, my professor for Dissertation Seminar randomly grouped us in pairs to discuss our dissertations. A student specializing in Literature became partnered with me, a specialist in Composition and Rhetoric.

“What’s your dissertation about?” I asked.

“Narrative historiography,” my peer replied.

Before giving feedback on his ideas, I had to ask, “Um, what’s that?”

“It uses narratology to examine literature that reimagines historical events.”

“Oh. What’s narratology?”

As we progress through undergrad, grad school, and doctoral programs, we travel a winding staircase that progressively narrows until only the people in our siloed specialty remain with us. We become adept at writing about narrative historiography to people who already know about it, but we forget how to discuss our research to people outside our specialties.

Grant applications, journal articles, and other publications often have broader audiences than our fellow specialists. Here are three tips for writing effectively to broader audiences.

Recognize the Curse of Knowledge

When you understand something, you have difficulty remembering what it was like to not understand it. This difficulty makes it harder to communicate your understanding to others who haven’t obtained it yet. That’s the “curse of knowledge.”

Even after my classmate explained narratology, I still didn’t quite get narrative historiography until he used the example of Michael Chabon’s The Yiddish Policemen’s Union. It’s a detective novel set in an alternate reality in which the Jewish nation-state resides in part of Alaska rather than in Israel. A hard-boiled detective investigates a murder and discovers a secretive group working to bring about the Messianic events required for a Jewish state in the Middle East.

Ooohhh! So “narrative historiography” is jargon for “how we tell stories about alternate reality and history.” Why didn’t you just say that? Because of the curse of knowledge.

To write clearly to non-specialists, you must be aware of the curse of knowledge. Remember there was a time when you didn’t understand your discipline like you do now. Remember that your audience may not understand it, think about how you came to grasp it, and adjust your communication to help them get it, too.

Hunt for Threshold Concepts and Jargon

The term “threshold concept” was coined by Jan Meyer and Ray Land. A threshold concept is a counter-intuitive idea that must be understood before you can fully understand other important concepts in a given discipline. A threshold concept transforms your views of discipline-specific content. Meyer and Land describe it as a “portal” to a new way of thinking. Often, we use jargon to name or describe threshold concepts.

For example, before you can understand “narrative historiography” as a concept in the field of Literature, you first need to understand that literature can be analyzed with a range of different paradigms, all grounded to varying degrees in the details of the text and the author. Once you realize literary analysis doesn’t make stuff up out of thin air, your view of literary analysis transforms.

To understand how CRISPR works, you need to understand DNA, RNA, and viruses. But when Jennifer Doudna explains CRISPR to lay-people, she doesn’t take it for granted that people share her deep understanding of genetics. She doesn’t use jargon like “gRNA,” “tracer RNA,” and “sgRNA.” Instead, she describes CRISPR as “cut-and-paste” and then walks her audience through some basic threshold concepts about DNA replication.

To mitigate the curse of knowledge in your writing, look for the threshold concepts and jargon whose understanding you take for granted. Then explain those concepts in more detail, using broadly familiar language, examples, and analogies.

Pretend You’re Writing to a New Grad Student

Of course, you can’t over-correct when writing to the non-specialists reading your grant application, journal article, or other publication. If you start explaining the scientific method to scientists, then you’ll offend your audience.

Imagine you’re writing to a new graduate student in your discipline. The student understands a lot about the discipline, but the student may not have achieved the threshold concepts, higher-level jargon, and paradigms that inform you as a PhD.

My classmate, for instance, didn’t need to explain the concept of using specific theories and paradigms in literary analysis (e.g., historical criticism, psychological criticism, etc.). I got that in undergrad. But he needed to explain higher-level concepts that hadn’t been part of either my Masters or my Doctorate in Composition and Rhetoric.

By pretending you’re writing to a new grad student, you can strike the balance between condescending to the audience and explaining what needs to be explained, between dumbing down your writing and providing the necessary details.

Example

Say you’re writing an NIH grant to fund research into neural trajectory representation. The reviewers will likely include fellow neurobiologists, neurologists, and neuroscientists. But will any of them specialize in continuous cortical signals, bioengineering, neural prostheses, or robotics? Will any of them understand directional tuning and population-based movement representation in the motor cortex?

To communicate about neural trajectory representation to these relative non-specialists, recognize the curse of knowledge, identify the threshold concepts and jargon that need to be explained, and pretend you’re explaining them to a brand-new doctorate student.

Using these tips, you might write something like the following:

Researching the neuronal connections in the motor cortex that fire when we move some part of our bodies could help bioengineers develop robotic prostheses that can be controlled with the mind. Neuronal firing in the motor cortex creates a neural ‘representation’ of the direction and speed of volitional movements. People can imagine volitional movements, creating the neuronal firing that leads to neural representation of trajectory. If connected neurally to robotic prostheses, imagining movements enables people to control the prostheses with their minds.

Instead of throwing around “neural trajectory representation” and “continuous cortical signals” like everyone knows those concepts, remember that you didn’t always know them yourself and that people outside your narrow specialty likely don’t know them either. Recognize the curse of knowledge.

To explain “neural trajectory representation,” you need to identify it as a threshold concept and explain it with the detail necessary for passing through the portal to a new understanding. Describing neuronal firing in the motor cortex allows you to explain that this firing creates a “representation” of both direction and speed, i.e., trajectory. Then references to “trajectory” in the context of neurobiology will make sense to neurobiologists with different specialties.

But the example doesn’t condescend by defining neurons, neuronal connections, neuronal firing, or the motor cortex. The neuroscientists and bioengineers reviewing the grant may not share your narrow specialty, but they still know a thing or two. Pretending they’re new grad students helps you explain what they need explained without over-explaining, offending, and wasting their time.

Conclusion

Influential literacy theorist Walter Ong says it’s essential to know what the audience knows and doesn’t know. That’s how writers know what to explain and what to assume.

Don’t let the curse of knowledge mislead you about what the audience knows and doesn’t know. Look for the threshold concepts and jargon that should be explained so your readers grasp what you’re trying to convey. Pretend you’re writing to a new grad student so you don’t over-explain.

It will avoid awkward confusion and questions about narratology, sgRNA, and neural trajectories.

 

Eric Sentell teaches writing and rhetoric at Southeast Missouri State University. He is the author of How to Write an Essay like an Equation and Become Your Own Fact-Checker. Learn more about his work at www.EricSentell.com.

Related Resources:

Practical Writing Advice from a Writing Teacher

An Entertaining & Robust Writing Roundup

Edge Writing Resources Roundup

 

Paper-Writing Checklists To Prevent Headaches Down the Road

Productivity / Writing & Publishing

Avoid authorship headaches and streamline the path from data to paper with these checklists.

CRediT Taxonomy

Developed by a group of librarians, information scientists, and the director of the MIT Press, the CRediT Taxonomy allows authors to define precisely the contributions every author makes to the paper. Potential contributions that can be attributed to individual authors include conceptualization, methodology, data curation, visualization, funding acquisition, project management, and writing (broken into original draft and reviewing/editing), along with several others. Use it at the beginning of a project to assign tasks or simply keep it in front of you as you and colleagues develop a paper, checking off items as contributed.

Several journals, including those published by Cell Press, now encourage or require use of this taxonomy.  The Consortia Advancing Standards in Research Administration Information (better known as CASRAI) collaborated with the NIH to link CRediT to ORCID and include contributor roles in publication metadata.

Get the checklist.

Authorship Grids

Two early career researchers and a journal editor recently put together a series of detailed authorship grids for quantitative, qualitative, and literature synthesis manuscripts as part of an article on grids’ use and effectiveness. The grids lay out responsibilities associated with the roles of first author, middle authors, and senior author in each type of manuscript, from who writes the IRB application to who coordinates manuscript revision.

Grids are meant to inspire discussion rather than regulate who does what, and so are completely customizable to your team, the project you’re doing, and how you prefer to split up the work.  They can also be submitted to journals for attribution of author contributions.

PubMed citation

Read the article and get the grids.

CONSORT Checklists

The Consolidated Standards of Reporting Trials (CONSORT) Group provides many resources and best practices for turning your trial into a paper to be proud of.  The most well known is the CONSORT 2010 checklist for reporting a randomized controlled trial, but they also provide checklists for reporting pragmatic trials, N-of-1 trials, harms, patient reported outcomes, and more.

The checklists provide both an explanation of what each of 25 elements of the paper should contain or look like for each kind of trial and examples of correctly written elements.  Using the checklist will ensure you include everything necessary for a complete and transparent report of your trial’s findings, from eligibility criteria to outcomes, randomization and blinding to losses and exclusions, and more.

CONSORT also provides a flow diagram for patient enrollment and progression through a trial. Not only can this be a useful figure in a paper, but it can help you plan your trial from the very beginning.

View the checklists. (Link defaults to CONSORT 2010 checklist; use dropdown at top right to explore other checklists.)

Get the flow diagram.

STROBE Checklists

STrengthening the Reporting of OBservational studies in Epidemiology (STROBE) has produced several checklists, similar to those from CONSORT, of what to include in each section of a paper on observational studies. The group has developed checklists for cohort, case-control, and cross-sectional studies.

Get the checklists.

SRQR Checklists

As above, developers of the Standards for Reporting Qualitative Research have created a checklist for papers in the qualitative research world.

Get the checklist.

If the checklists above don’t fit your type of research, never fear: The EQUATOR Network (Enhancing the QUAlity and Transparency Of health Research) has Get the checklist. to suit all kinds of research. Whether you do animal studies, case reports, systematic reviews or economic evaluations, there’s a list to help you showcase your data in the clearest, most effective and complete way.

Additional Resources

Vexing Issues for New PIs: Picking Corresponding Author, Potential Reviewers, Blacklisting and Other Angst

A Big Step Forward in Standardizing Rules for Authorship

Author, Author, Who’s Got the Author?

Research Manuscripts Should Tell Really Good Stories

Book Reviews / Writing & Publishing

Book Review: The Art of Scientific Storytelling by Rafael E. Luna, PhD

Chapter 1: Introduction

Skim or skip. This section promotes the book and the promising ideas it conveys, when many of us (me, me, me) just want to get to the meat of the book. After several pages it reads as blah, blah, blah.

Key takeaways: The author, (who is Executive Director of the National Research Mentoring Network), has golden credentials and oodles of experience to share to help you write better.

Figure 3

Chapter 2: Fashioning Your Scientific Story Using the Basic Elements of Narrative Craft

Here’s the content I expected earlier. If you’re already familiar with narrative arcs, this section will feel familiar. If storytelling form is a new concept, then this can help identify the various narrative structures and prepare you to think creatively about how they apply to a research manuscript.

Figure 3 (at right with modifications) helps make the connection without needing to read the entire chapter. The Essential Toolkit of Storytelling Terms is basic, but does teach how to apply these terms directly to the scientific paper you are writing.

Key takeaways: Lifecycle of a Scientific Story begins with the Introduction, Results Section 1, Results Section 2, Results Section 3, Results Climax, Results Validation, and ends with the Discussion.

Chapter 3: An Order of Operations to Streamline Scientific Storytelling

A bit too wordy when telling stories within the larger story. I would prefer to cut to the chase and lay out the steps needed, which does happen by about the fourth page of the chapter, along with some solid general writing guidelines to consider in early drafts.

Key points are summarized in the following excerpt:

“The Introduction ushers your protagonist into a scene with a major problem/scientific unknown, which sets up your hypothesis. Results Sections 1, 2, and 3 show the protagonist undergoing increasing tension by step-wise experimentation to address the major problem/scientific unknown (overall hypothesis), which drives the reaction forward to its highest tension. The Climax experiment is the critical experiment that is centered on the protagonist and provides the strongest evidence for the major findings in the research study, which drives the reaction toward completion. The Validation step lends the most credibility of the study by making a step that makes your story believable. The Discussion section places your results in the context of the current literature, returning your protagonist to his original scene and showing how he is irrevocably changed.”

Key takeaways: The structure of research narrative mirrors other stories, and you can break it down by section. In fact, you should break it down by section and carefully include essential supporting details.

Chapter 4: Specifics for Writing Each Section (Here are the meat and potatoes!)

In the longest (and best) chapter of the book, we get section-by-section guidance on topics like selecting the best title, abstract essentials (sentence by sentence), storytelling through figures, results, introduction, discussion, and finally revision. These steps read a bit like recipes, and offer concrete and clear guidance about what to include.

The author notes:

“If you remember only two things from this book, it should be the following:

1.) A hypothesis can be defined as Conflict Resolution, which is the basis of all stories, especially Scientific Storytelling.

2.) Boldly state your testable hypothesis in your Title and throughout the text of your manuscript provide scientific evidence to substantiate your hypothesis (or in the urban vernacular: Drop the Mic!).”

Included at the end is a quick-start guide to hosting a Scientific Storytelling workshop of 6-18 participants along with critical analysis questions, which can be helpful even outside of the workshop setting and in solo editing.

Key takeaways: Use this section of the guide when crafting your first draft, then refer back to it throughout the revision process. If you mentor, consider if the Scientific Storytelling framework offers a fresh way to bring out more nuances of the flow of scientific writing.

Additional Resources:

Bespoke Tailoring: Why You Want to Work with a Writer/Editor

Writing & Publishing

Pitching your luxury hotel to investors? Aiming for the executive suite? Moving towards partnership in an international law firm? Odds on you’ll invest in a high-end wardrobe. First impressions dominate. The out-of-pocket expense is a stepping stone to your goal. A $2000 suit makes sense when the gain is millions.

Hiring a medical editor is like having a bespoke tailor. No one cares what I’m wearing, but I want my work to step out completely dressed for success. Because we make our pitch in writing, work products have to be flawless presentations.

I have an undergraduate degree in writing and masters in science writing from Johns Hopkins. I have earned significant income in the past by writing and editing. I regularly work with an editor* for my most important products. Why? Because I and my research team have millions to gain (aka grant funding and publications that sustain our research). More eyes on make a more perfect product.

Don’t pour your intellect and soul into your scientific passions – your start up – and fail to get a foot in the door because of how your science is “dressed.” We write for a living. We write to explain our methods, to convey our findings, to explain the implications, and to inspire enthusiasm for our next research goals. Do not be fooled, we are marketing our findings and selling our next project. We compete our ideas. Writers and editors can help the work be elegant and polished going into the arena. Strong clear writing confers confidence in your attention to detail, deep understanding of your work, and by extension your abilities and trustworthiness as a scientist. Fair? Of course not, but first impressions matter precisely because the individual forming the impression is not consciously doing so.

Enthusiasm for your science is a gut level response you can influence to your advantage at relatively low costs. Writers and editors can help you be more productive and prepare your science to go more quickly and attractively into the world. Illustrators can make the message more tangible, technical editors can redeem your time by formatting to journal specification, clerical support can organize your bibliographic database, writers can draft cover letters or manuals of procedures to free your time to focus on discovery. More people than you imagine are quietly using these resources. I’m not sure why they feel the need to keep it hush-hush. No shame attaches to working smart.

If you have discretionary funds or training grant funds, often these can be deployed through your work to pay invoices. Ask. You don’t have much to lose. Some faculty have discovered a science writer on retainer in their department or deeply discounted costs for early career investigators by asking. Or form a free accountability structure with peers, like manuscript sprints, to be able to learn to edit and to receive feedback on your work. What you want is a durable, ongoing commitment to group editing, not a 45-minute work-in-progress. Work-in-progress with your research team is crucial but unlikely to be enough buffing.

If you must, pay out-of-pocket. But I still shop at Target!?! I can’t afford this luxury. Scrimp, save, take public transportation, don’t go out to dinner or order pizza, eat rice and beans, put stuff on Craigs list, but make the investment in your career. If I had permission (and I don’t per hush-hush phenomena above), I would share the names of senior people who have had writers as assistants for most of their careers. Writers who are now at their sides well into their leadership roles. Most began the practice very early in their careers. I also have testimonials from early career faculty who firmly believe their grants were funded because of the work of an experienced editor. Why make your work compete in Dockers and a serviceable sweater when it can arrive at the party in a custom tuxedo? You’ll slay them with attention to detail. You want to celebrate the win, right?

 

* Disclaimer: No editor was involved in the tailoring of this post.

Resources:

American Medical Writers Association Directory – Freelance Directory Search

National Association of Science Writers – Find a Writer

Australasian Medical Writers Association list of freelance writers/editors

And the publication below finding: “In this sample of open-access journals, declared professional medical writing support was associated with more complete reporting of clinical trial results and higher quality of written English.”

Gattrell WT, et al. Professional medical writing support and the quality of randomized controlled trial reporting: a cross-sectional study. BMJ Open. 2016;6(2). PMC4762118.