3 ms·
• Don’t slow the reader down. Avoid footnotes because they break the flow of thoughts and send your eyes darting back and forth while your hands are turning
by YeGoblynQueenne 7y ago
• Don’t slow the reader down. Avoid footnotes because they break the flow of
thoughts and send your eyes darting back and forth while your hands are
turning pages or clicking on links. Try to avoid jargon, buzzwords or overly
technical language. And don’t use the same word repeatedly — it’s boring.
• Don’t over-elaborate. Only use an adjective if it’s relevant. Your paper is
not a dialogue with the readers’ potential questions, so don’t go overboard
anticipating them. Don’t say the same thing in three different ways in any
single section. Don’t say both ‘elucidate’ and ‘elaborate’. Just choose one,
or you risk that your readers will give up.
"Don't use the same word repeatedly" and "don't say the same thing in three
different ways in any single section" are contradictory.
In particular the first bit of advice is not good advice, to my bitter, bitter
experience. I used to do this in my papers: I would vary the terminology I
used to refer to the same concept throughout a paper, to make the text more
interesting. This was criticised very strongly and caused untold confusion
among reviewers, and the confusion caused my work to be rejected with very
strongly negative comments. And that's not just papers- I kept having to re-do
the reports on the progress of my research required by my university, because
the internal examiners wer so confused by the way I was writing.
Then I had a single session with a woman from the unversity's center for
academic English and that was one of the first things she said to me: "use the
same term to refer to the same concept, throughout the text". It was like a
lightbulb went off and the next set of comments I got for my work was
overwhelmingly positive (with respect to my technical writing anyway). It was
just This One Simple Trick, right? But it made a world of difference.
And here's a more general bit of advice: if you ever enjoyed literature, or
indulged in writing your own, woe is you, o damned soul. Do not even consider
trying to write a technical paper as if it was literature. You will be damned
for ever to the eternal flames of damned damnation. Really- don't do it.
Literary writing is evocative, it creates fleeting impressions and conjures
emotions. Done right, no two readers will get the same impression from the
same literary text. But the same is death for technical writing. Technical
writing is precise and unambiguous. Everyone who reads it must understand it
and they must all understand the same thing. Don't mix the two kinds of
writing up or you'll make a mess. Like I have.