TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Three sins of authors in computer science and math (1997)

126 pointsby kcolfordover 3 years ago

20 comments

spekcularover 3 years ago
I disagree with a lot of this. My perspective comes from reading papers in mathematics and physics, not computing, however.<p>Regarding &quot;grandmothering&quot;: I agree with the criticism of the first example. Explaining basic points of the field in a vague way is obviously not helpful. The second example is not as compelling. The key point is that the &quot;...&quot; after &quot;In recent years, the study of preconditioners for iterative methods for solving large linear systems of equations, arising from discretizations of stationary boundary value problems of mathematical physics, has become a major focus of numerical analysts and engineers&quot; usually contains a string of citations. These citations serve to point the reader to the recent works mentioned in the sentence, which may not be readily accessible to someone who doesn&#x27;t actively do research in that area but is otherwise knowledgeable about numerical computing.<p>In particular, the author reasons such introductions are bad because &quot;the bulk of the paper is accessible only to those sufficiently expert in the field to know everything in the first two paragraphs of the introduction cold.&quot; But this is just wrong. There are plenty of math&#x2F;physics papers where I can follow the arguments line-by-line, but I don&#x27;t know the state of the art in the field or why the problem under consideration might be important. I don&#x27;t think I am alone.<p>Regarding, &quot;A table of contents in a paragraph&quot;: I think the author is partially correct. For short papers, it&#x27;s perfectly fine to fold this part into the introduction (e.g. in the outline of the proof). But for longer works where the proof is decomposed into multiple lemmas and sub-lemmas, these can be very useful. If one writes the proof in a very clear and structured way, then maybe such &quot;shotgun summaries&quot; can be avoided. But this is not always possible.<p>Regarding conclusions that only repeat the introduction: I agree here.
评论 #29258691 未加载
评论 #29258911 未加载
评论 #29263535 未加载
评论 #29262581 未加载
评论 #29260747 未加载
评论 #29259236 未加载
评论 #29258085 未加载
porcodaover 3 years ago
I agree these are annoying patterns, but I honestly don’t notice them. I don’t read research papers like a book, front to back. Often I skip the abstract, skim the intro, skip to the conclusion to skim what they say I’ll find, and then read the core. The table of contents paragraph I skip without thinking about it.<p>I’m more bothered by people who use bizarre notation, don’t provide sufficient definitions&#x2F;background, and don’t give enough information to reproduce the results myself (and I’m not talking about a git repo). I could care less if they have useless sentences and repetition if the content and methodology is complete and understandable.
评论 #29258098 未加载
评论 #29259056 未加载
trulyover 3 years ago
In CS, another sin is that you have to &quot;justify&quot; the significance of the results even in theory conferences.<p>Hence many papers contain exaggerated claims with respect to practicality, importance and so on.<p>Another sin is that the results need to be &quot;difficult&quot; and &quot;surprising&quot; in order to publish. Hence, if you present your story in a simple-to-understand fashion, you run a high risk of rejection. Better not simplify your results before publishing -- keep all original notation, even if you figured out you do not need that many indices.<p>This has become a dogma and there is little chance of all this nonsense stopping anytime soon.<p>It is refreshing to read old papers that merely get to the point and are significant while being nice to read.
评论 #29259366 未加载
rrobukefover 3 years ago
I don&#x27;t agree with the author. For me each of the sins have their goal that isn&#x27;t in what they state. I wonder what the author thinks of this almost 25 years later.<p>-----<p>* The grandmothering: Too often have I read an abstract, not understood it (since an abstract is allowed to be dense), and quit on these first lines orienting the paper in the field . If it&#x27;s your field these lines don&#x27;t cost, if you&#x27;re a newcomer, or from another field, you get the keywords you need to know before starting. And often you know this paper isn&#x27;t what you were looking for. As for the near-meaninglessness of this sentence: look up the first sentence of any book. You can&#x27;t put 100 pages in one sentence.<p>* The table of contents: writers can&#x27;t actually insert a table of contents, yet a paper needs it. True, nobody cares what&#x27;s in Section 5, yet without this sentence you don&#x27;t know when it will end, you don&#x27;t know what you get. You care about how the content escalates. Also note that each of the sentences is more than just the title of the section. The actual title of Section 6 is just &#x27;Time complexity&#x27;.<p>* Conclusions that don&#x27;t: His solution is literally the opposite of what is taught. Yes to a perspective, no to new information. Also his example is incomplete, three more sentences follow that are not summarizing.
评论 #29259520 未加载
评论 #29260417 未加载
评论 #29258552 未加载
ModernMechover 3 years ago
The grandmothering complaint misses what I think is the main purpose of the introduction section of a paper: to orient the reader. I’m <i>hoping</i> it tells me something I already know, because how else am I going to build a bridge to the new knowledge the paper promises?<p>Moreover, it’s really not telling me what <i>I</i> know — it’s telling me what the <i>author</i> knows. If the author has a strange perspective on things I think I know, then it’s going to make understanding the rest of the paper much harder; how can I trust this author about unknown subjects when we can’t agree on topics of which we ostensibly share a common understanding? Such context is especially important when we are talking about the far edges of knowledge.
pfortunyover 3 years ago
The “table of contents in a paragraph “ is almost compulsory in any engineering (even applied maths) paper, in most journals… As far as I can tell.
评论 #29257996 未加载
评论 #29258136 未加载
评论 #29259534 未加载
joe__fover 3 years ago
I agree with the overall idea, that many papers in mathematics and related fields could benefit from their authors spending more time on their writing style.<p>I disagree with most of their suggested ways of doing this. * Grandmothering: I didn&#x27;t understand the point here. I think writing an overview sentence in your abstract can be helpful. * Table of contents in a paragraph: Whatever it&#x27;s just one paragraph, if you don&#x27;t like it don&#x27;t read it * Conclusions that don&#x27;t: I think the having first paragraph of your conclusion as a reintroduction is very helpful. I sometimes read only the conclusion, and I often find the summary paragraph at the beginning of the conclusion to be more direct than other parts of the paper. Clearly the example of changing the tenses of the verbs in the introduction and putting this again as the conclusion is inexcusable, but I&#x27;d be surprised if that happened other than in the one place the author came across it
kazinatorover 3 years ago
Conclusions that don&#x27;t conclude, but re-state the introduction are bade?<p>But that just follows from the time-honored recipe for essay writing:<p>1. First tell &#x27;em whatcha gonna tell em.<p>2. Then tell &#x27;em.<p>3. Then tell &#x27;em whatcha told &#x27;em.<p>To conclude doesn&#x27;t mean to draw some new logical inference, but just to bring the paper or talk to an end.<p>You don&#x27;t introduce anything new in a conclusion.<p>Not any kind of conclusion.<p>E.g. a musical symphony will rarely introduce entirely new themes in the last bars. Instead various ending devices occur, like condensed re-statements of themes that occurred previously.
评论 #29261330 未加载
Robotbeatover 3 years ago
It’d be nice to have a bunch of positive examples.
aimorover 3 years ago
Authors get pushed into writing like this, then readers learn how to read a scientific paper. The point is: a lot of people put up with this process and don&#x27;t feel incentivized or empowered to challenge it with their own work. I hope it&#x27;s painful enough that something better is adopted, but after 25 years it hasn&#x27;t happened yet.
scrubsover 3 years ago
I&#x27;m guilty of sin two. And I can see the op&#x27;s point. So I can amend, improve.<p>One sin that ought to be included replete in CS, math, and physics papers my English writing instructor made me stop: parenthetical phrases. Excessive footnotes are another variation.<p>Readers are not interested in the author&#x27;s breadth-first association of one fact to 87 other facts.<p>Fixing this requires two things: knowing associations is certainly good. But know what&#x27;s for you and what&#x27;s for the reader. Second, know the point you&#x27;re trying to make and nail it without bringing in half baked facts or edge cases.<p>In my papers I cut all that out. I either connect and explain clearly or I omit.<p>Re: grandmothering: I totally agree with op: if I&#x27;m a specialist in the area it&#x27;s not value add. Like too many Ted talks it&#x27;s people telling the in crowd what they probably already agree with. If not a specialist it&#x27;s inaccessible. Either way it&#x27;s bad, it&#x27;s waste.
MathMonkeyManover 3 years ago
The author seems to value direct, polished prose. Surely some academic writing is direct and polished, but most of it isn&#x27;t.<p>Writing an academic paper is the existential obligation of its authors. There&#x27;s something in there that you want to get across to somebody, but the rest of it be damned. I&#x27;d expect the quality of the prose to be a low priority, not unlike in much developer documentation, school book reports, speeches, and other writing that is mostly filler to meet an obligation.
kbensonover 3 years ago
At first I thought the author was purposefully eschewing any useful formatting to make a point later about how this work itself would be easier to read if a minimal amount of formatting was provided to make it more palatable to those reading it, but no, upon checking other pages of theirs, and even loading up developer tools in case some CSS file was failing to load (and finding none), it seems this author is blind to their own shortcomings in communication.
评论 #29257949 未加载
评论 #29263133 未加载
评论 #29263015 未加载
评论 #29257975 未加载
评论 #29258052 未加载
评论 #29257830 未加载
onhnover 3 years ago
&gt;Really Bad Acronyms, or FBAs, are spawned by FNPLs (Nerdy Project Leaders) when naming new systems<p>Nothing like personal attacks to get your point across. Well done author.
评论 #29258066 未加载
jmmcdover 3 years ago
The bigger and more interesting point is how to navigate the world of research where everyone is convinced their way is the only right way. I paragraph-TOCs, but my reviewer insists on including it. This article is an example.<p>We need a better way to establish consensus for things that can be standardised and we need more taste and tolerance for things where opinions can differ.
evougaover 3 years ago
I’ve tried writing papers without conclusions, only to have reviewers call out that “the paper has no conclusion.”<p>As for the comment about bad project names and acronyms: Jonathan is most famous for developing the “Triangle” code for Delaunay triangulation, and “Triangle” is of course impossible to Google. Should have chosen a more distinct acronym! :)
graycatover 3 years ago
My view, from math, computing, and computer science is (1) that the author is being too critical and often throwing out a small but good baby with some not very dirty bathwater and (2) that he is not mentioning some larger problems, worse &quot;sins&quot;.<p>Here would be my list of the worst <i>sins</i> or how to avoid them:<p>(1) A <i>term</i> is a word used with other than a standard dictionary definition. Technical fields are awash in terms. Make sure to try hard to define all the terms you use; with some judgment applied, can omit definitions of some terms certainly well understood by any reader with enough background to get anything from the paper. Poorly or undefined terms can be one of the best ways to lose readers. Here, hoping to get more readers, maybe inviting them into the field, bend over backwards in defining terms, that is, maybe give some term definitions for readers who, really, have little hope of getting much from the paper -- at least, when such a reader gives up they won&#x27;t blame the author!<p>In addition, for any term new or relatively new to the field, with some judgment, might also include for the term motivation of its importance and examples of its usage -- i.e., make clear the importance, relevance, value, usage, etc. of the term.<p>(2) For nearly all acronyms, standard in the field or not, for the first use of the acronym include what it abbreviates. Here to be sure are doing well on this issue, strain and bend over backwards and include, say, even TCP (transmission control protocol), SMTP (simple mail transfer protocol), CPU (central processing unit) -- sure, I&#x27;m suggesting bending over backwards. Several slaps on the wrist, an hour in the corner with wearing a dunce cap, and a coating of tar and feathers for each acronym used but not defined with what it abbreviates.<p>(3) For how to write math, in two parts, (A) and (B):<p>(A) Take some theorem proving courses from some of the most precisely written texts, say, P. Halmos, <i>Finite Dimensional Vector Spaces</i>, W. Rudin, <i>Principles of Mathematical Analysis</i>, Neveu, <i>Mathematical Foundations of the Calculus of Probability</i>, E. Nering, <i>Linear Algebra and Matrix Theory</i>, Royden, <i>Real Analysis</i> where do a lot of the exercises as homework and where the professor DOES read and remark on your writing. Neveu was a Loeve student at Berkeley. Nering was an Artin student at Princeton. As I recall, Rudin&#x27;s background was in Austria, although I don&#x27;t know who his professors were. Of course, Royden was long at Stanford. For more, if have time and insist on some really good examples, read some of Bourbaki.<p>By the way, on use of <i>we</i>, that is standard. So we might have,<p>&quot;Given topological spaces X and Y and a function <i>f: X --&gt; Y</i>, we say that function <i>f</i> is <i>continuous</i> provided for each set <i>B</i> open in <i>Y f^(-1)(B)</i> is open in <i>X</i>.<p>So, that&#x27;s a vanilla example of using <i>we</i> in mathematical writing.<p>(B) Do some things none of those texts do: Include some intuitive views, some helpful pictures, motivation via applications in math and also outside math, and outlines of research directions.<p>There is a lot of question about how appropriate is suggestion (B); in math my guess is that there is no question about the relevance, wisdom, importance, value, etc. of suggestion (A).<p>For the goal of writing math, suggestion (A) is important: Tough to expect good success without the texts I listed or other texts written with similar care. That level of care is extreme, tough to find and learn, and much tougher to do. Writing math with the care of those texts seems to have been understood and practiced significantly often only after about 1950 or 1940. And for at least one course from at least one such text, DO have the good homework grading of a good math professor.<p>Personal experience and lesson: While I&#x27;m not much interested in being a professor, I have published some papers, and from getting those papers reviewed my guess would be that about half of the reason the papers passed review, and they always did with no significant revision or difficulty, is that I wrote the math with nearly the care and precision of, say, W. Rudin. Point: To critical readers, any lapse in that level of care and precision can be like a worm in a baked apple, perhaps otherwise terrific from brown sugar, butter, etc. Or, might guess that, in nearly any field, the good work is less than 10% of the total, maybe less than 1%, with the rest <i>flawed</i>, maybe as bad as that apple with a worm. In writing math, it is way too easy to be in the bottom 99% or 90% just from the care and precision of the writing, and suggestion (A) is IMHO (in my humble opinion) a good way to have at least the writing quality keep you in the top 90+%.<p>For math used in computer science, for how to write that math carefully, there are of course examples from D. Knuth.
paulpauperover 3 years ago
I don&#x27;t think this really matters. What matters much more so is having good findings.
swayvilover 3 years ago
Unnecessary verbosity should be at the top of the list. Without clarity (brevity being the soul) the rest fails.<p>They say that the google crawler won&#x27;t take you seriously unless you include your life story as prelude to that recipe for pb&amp;j. Is this making everything less clear?
toxikover 3 years ago
Don’t follow this advice, it will make it harder to get accept.