Scientific writing

Scientific writing style is frequently terrible. In my undergraduate days I was enrolled in a linguistics program. The psycholinguistics content was greatly concerned with questions like how (relatively) hard e.g. subordinate passive voice are for our brains to process. We would quantify that by e.g. measuring how long people needed to pause to understand such a passive phrasing compared to something in the active voice. And of course, the essays on these themes had to be written with hard-to-parse scientific style, such as subordinate clauses, and passive voice and various other things that we knew made our essays measurably harder to understand.

Why do we do this to ourselves? Possibly because writing is just plain hard, harder in your second language (and scientists tend not to be writing in their mother language), and possibly because a shadowy conspiracy of lecturers aims to create demand for remunerated means of education delivery, such as lectures, where they explain well in person what they obfuscated in book. The academic elites would be, that is, in the pocket of Big Talk.

Or maybe possibly because your graduate committee feels they need to give you some feedback and if they do not understand the content of your writing then at least they might feel you could benefit from being told to talk more defensively pretentious.

Can we do better (i.e. more beautiful, more comprehensible) while still using enough appropriately rococo status signifiers to get our work published? I am especially interested in good mathematical style, but academic style in general could be good to know.

Yes, mostly. Good academic writing seems to me to be about finding a compromise between my aesthetic and academic status dialect. While I will never get to write a paper the same way I would explain it in person, at least I can avoid some of the bullshit and still be publishable. Put another way, there is a comprehensible style hidden within the status-signaling academese dialect. In public science communication I can probably aim for my actual preferred style.

It might be good at this point to distinguish several possible style of writing that I might like to be good at:

• Journal-style prose, which has a particular cloistered academic style (passive voice etc) which is necessarily hamstrung, but can be done better and worse within its constraints
• Public science communication, where I can use certain forbidden words (e.g. “I”) but often must presume less specialist knowledge from my audience.
• Peer, or educational science communication, wherein I can use specialist jargon plus whatever language I need to motivate intuition in my listener.

Inger Mewburn hates conventional academic style:

Academic writing, as a genre, is ritualised, peculiar, archaic and does almost as much to hide knowledge as it does to share it. Mastering academic writing is just as much about signalling you are the member of an ‘in-group’ as it is about conveying ideas.

Don’t believe me? Look at how we use commas.

Commas help you create longer sentences that still make sense. Without commas, you have Parataxis. Parataxis is Plain English. Just one sentence. Followed by another sentence. Parataxis is direct. Your sentences are short.

Perhaps too short?

When you have too many commas you create hypotaxis: the use of clause after subordinate clause, which creates sentences of deeply satisfying complexity, that, even while you might get lost a little between the commas, reassure the reader that an academic of sober-minded, careful, disposition is tapping away at the keyboard crafting very, very polite sentences which, because of those glorious clauses and subordinate clauses, will make you feel like you’re eating dry toast. You’re on safe ground with all that hypotactic fun, believe me, because it’s impossible to be too enthusiastic, or too rude, about anything when you write this way. It’s no wonder, since academics love being passive aggressive, …that most ‘serious’ writing is full of it.

Thomas Basbøll counters Mewburn’s argument about in-group signalling by extolling the virtues of a productive in-group:

This, then, is my advice to doctoral students and early career researchers. Spend some time looking for a group of people you like writing for and just go ahead and enjoy it for a few hours every week. (I recommend at least two and a half hours and at most fifteen.) This will all be happening within you, in your heart and mind, so you are in control of the moment. Keep the mood warm and collegial. Don’t spend a lot of time writing for readers you don’t like, or readers you fear, or don’t respect, or feel humiliated by. Spend most of your writing time among your peers. Enjoy their company.

One could take away from both these a need for awareness of context.

To meet the Key Performance Indicators of Australian research it is generally best to churn out endless stylized academese in order to get as published as often and expeditiously as possible, without pause to make it comprehensible to the public, or even other researchers who aren’t sufficiently close to your field to be a gatekeeper. The goal is to be just comprehensible enough not to annoy good reviewers and maybe even just incomprehensible enough to intimidate bad reviewers into accepting your work.

We could, nonetheless, be a little bit better off, I feel, by tithing a small amount of effort to less abhorrent journal submissions, perhaps? Also, advocating for a system which permits this?

Also, I can complain to other researchers, I suppose.

OK, but how to do better within the constraints we have? There is no shortage of advice about that. Too much, even. Advice alone will not fix perverse incentives. Nonetheless, advice is a necessary part of the solution. Maybe at some point I will have time to better triage all these resources and find out which ones have, e.g. evidential support rather than being the groundless mumblings of latter day prescriptive grammarians. For now, a fountain! a cornucopia! A jungle of verbiage on the topic of how to omit needless words.

J.S. Milne, tips for authors:

If you write clearly, then your readers may understand your mathematics and conclude that it isn’t profound. Worse, a referee may find your errors. Here are some tips for avoiding these awful possibilities.

Jonathan Shewchuk, Three Sins of Authors in Computer Science and Math:

I’m not going to give you the usual advice that you fuss and fret over your introduction until it’s perfectly attuned to the psychological motivations of every potential reader. If everybody had time to do that, bad writing wouldn’t be a problem. Instead, I’m going to offer advice that will save you time: get to the point!

Henning Shulzrinne, Writing technical articles

A good research paper has a clear statement of the problem the paper is addressing, the proposed solution(s), and results achieved. It describes clearly what has been done before on the problem, and what is new.

The goal of a paper is to describe novel technical results. […] A paper should focus on

• describing the results in sufficient details to establish their validity;
• identifying the novel aspects of the results, i.e., what new knowledge is reported and what makes it non-obvious;
• identifying the significance of the results: what improvements and impact do they suggest.

He also quotes Craig Partridge:

One goal of the paper is to ensure that the next person who designs a system like yours doesn’t make the same mistakes and takes advantage of some of your best solutions. So make sure that the hard problems (and their solutions) are discussed and the non-obvious mistakes (and how to avoid them) are discussed.

Just imagine if that happened on a regular basis.

Dan Robitzski, This Grad Student Used a Neural Network to Write His Papers (although the student in question credits the poor standards of business school as the secret rather than the amazing powers of GPT-2).

Van Savage & Pamela Yeh, Cormac McCarthy’s tips on how to write a great science paper:

• Use minimalism to achieve clarity. While you are writing, ask yourself: is it possible to preserve my original message without that punctuation mark, that word, that sentence, that paragraph or that section? Remove extra words or commas whenever you can.
• Decide on your paper’s theme and two or three points you want every reader to remember. This theme and these points form the single thread that runs through your piece. The words, sentences, paragraphs and sections are the needlework that holds it together. If something isn’t needed to help the reader to understand the main theme, omit it.
• Limit each paragraph to a single message. A single sentence can be a paragraph. Each paragraph should explore that message by first asking a question and then progressing to an idea, and sometimes to an answer. It’s also perfectly fine to raise questions in a paragraph and leave them unanswered.

Upon reflection, I am ambivalent about this advice.

Roger’s Bacon: Research Papers Used to Have Style. What Happened?

E.T. Jaynes channelled though Tom Leinster on the generous reading of mathematics. Some generosity of patience will be needed to weather his verbose style.

If you differentiate a function \(f(x)\) without first having stated that it is differentiable, you are accused of lack of rigor. If you note that your function \(f(x)\) has some special property natural to the application, you are accused of lack of generality. In other words, every statement you make will receive the discourteous interpretation.…

fanatical insistence on one particular form of precision and generality can be carried so far that it defeats its own purpose; 20th century mathematics often degenerates into an idle adversary game instead of a communication process.

The fanatic is not trying to understand your substantive message at all, but only trying to find fault with your style of presentation. He will strive to read nonsense into what you are saying, if he can possibly find any way of doing so. In self-defense, writers are obliged to concentrate their attention on every tiny, irrelevant, nit-picking detail of how things are said rather than on what is said. The length grows; the content shrinks.

Mathematical communication would be much more efficient and pleasant if we adopted a different attitude. For one who makes the courteous interpretation of what others write, the fact that \(x\) is introduced as a variable already implies that there is some set \(X\) of possible values. Why should it be necessary to repeat that incantation every time a variable is introduced, thus using up two symbols where one would do? (Indeed, the range of values is usually indicated more clearly at the point where it matters, by adding conditions such as \((0 <x < 1)\) after an equation.)

For a courteous reader, the fact that a writer differentiates \(f(x)\) twice already implies that he considers it twice differentiable; why should he be required to say everything twice?

This is a different diagnosis of a major ill than other competing complainants. For example, Shaun Lehmann, the vagueness problem in academic writing:

[It is] likely that your writing was suffering from ‘vagueness’ — a constant problem in English. English-speaking readers (especially in an academic context) will only do a very small amount of work to figure out what you mean before they respond with confusion. […] A useful technique is to learn to read your work through the eyes of a kind of caricature of the low-context communication mode. You need to imagine a reader who is highly intelligent and logical, but who has no common sense and will fail to interpret any multiple meaning in the way you had intended.

I call my version of this the Commander Data Meditation […]

Nick Higham, Handbook of writing for the mathematical science has style and typographical tips that seem useful Not only may they make your writing easy to read (?) but also they are identifiable signifiers of people who have read Nick Higham which is a useful shibboleth.

Public Library of Science Writing Center:

A collection of free, practical guides and hands-on resources for authors looking to improve their scientific publishing skillset.

• Simon Peyton Jones’ pointers to useful advice after his own seminar on how to write a paper.
• You and your research, Hamming’s famous 1986 talk on how to do great research.
• The Navigators Research Book of Style is a slide deck from the Navigators research group at the University of Lisbon. It covers choosing a research topic, doing research, and writing and submitting a paper.
• Research tips (including how to do research, how to write and present a paper, how to design a poster, how to review, etc), by Sylvia Miksch
• Notes on presenting theses, edited by Aaron Sloman, gives useful guidelines and ideas for PhD students writing their thesis.
• Chris O’Leary’s essays about writing an “elevator pitch”. This stuff, especially the list of attributes in the “Elevator pitch 101” page, is very relevant to writing a good grant proposal.
• A scrutiny of the abstract by Kenneth Landes in Geological Notes. These short notes give guidance about writing the abstract of your paper.
• Norman Ramsey’s notes about his class on Technical Writing.
• Mathematical Writing, by Donald E. Knuth et al. The first three sections constitute a minicourse on technical writing: only eight pages long. The time to read it will repay itself many times over.
• How to Write Mathematics, by PR Halmos.
• Gian-Carlo Rota’s excellent talk Ten lessons I wish I had been taught, which, among other things, has a bit to say about giving a talk.
• David Patterson’s talk How to have a bad career in research/academia has many wise things to say on a related topic.
• Mark Leone’s page has a good collection of links to other resources.
• Producing wrong data without doing anything obviously wrong! Mytkowicz, Diwan, Hauswirth and Sweeney, ASPLOS 2009.
• Derek Dreyer’s excellent PLMW’16 talk “How to write papers so that people can read them”(slides here, video here) tackles exactly the same question as my talk, and also offers seven concrete suggestions — and they are interestingly different from mine!
• The blog post by Igor Pak on ‘How to write math papers clearly’ is also useful.

Also helpful, Julia Evans’ Patterns in confusing explanations.