Live data from Hacker News

Common bugs in writing (2021)

cs.columbia.edu

31–40 of 99 posts

Re: Common bugs in writing (2021)

#31

I try to post this advice in every similar thread: if you want to get better at communicating information through writing, then On Writing Well by William Zinsser is really worth your time.

I enjoyed Writing Well and think my writing improved as a result. Another useful book is Christopher Lasch's Plain Style.

Re: Common bugs in writing (2021)

#32
post #14
post #5

I'm a little perplexed as to why professors and other academic staff have routinely hard to read websites. Yes I'm aware I can bump up the font size, but especially on mobile that gets annoying. It's one thing if they don't have a stylesheet what so ever, it's a fully another thing to intentionally make things hard to read: font-family: arial,verdana,sans-serif; font-size: small; From an article that expressly advoca…

> Avoid excessive parenthesized remarks as they make the text hard to read chuckles nervously in Lisp

*chuckles nervouthly*

Maybe it's the nesting that's the problem? Like, refactor it out into its own function/paragraph?

Re: Common bugs in writing (2021)

#33

Vale is an OSS tool that you can use as a "prose linter" with many of these rules. You can also write your own rules. Together with a spellchecker its a good replacement for proprietary tools like grammarly. - https://github.com/errata-ai/vale

This is interesting, I integrated it into my blog straight away, thanks!

Are you aware of any academic writing focused extensions for Vale? In specific, I would need different "style" as it's called on Grammarly.

Re: Common bugs in writing (2021)

#34
post #11

When I was doing my PhD, I was really in love with such guides. There is also the book Bugs in Writing by Lyn Dupré. Looking back I'm not so sure about the utility in scientific writing. Every research community has its own jargon. If don't stick to it, you're going to have a hard time. Today, I very much enjoy these again because most writing happens in a blog. I would add to that list (not original from me): - Dang…

Longer than when it's not a Saturday

Longer than staying in bed shorter when it's a Saturday.

Re: Common bugs in writing (2021)

#35

One of my pet peeves is when the writer uses a pronoun immediately after a sentence with multiple proper nouns. For example, something like "Biden ran against Trump in 2020, and he raised a lot of money".

This kind of ambiguity is rampant in technical writing. Example: "There are situations where developers do X instead of Y which is the wrong thing to do." Wait, is X wrong or Y?! You go ahead and assume X is wrong and then figure out later they meant Y is wrong or vice versa. Argh!

Re: Common bugs in writing (2021)

#36
post #30
post #7

> Avoid use of passive tense if at all possible. Example: "In each reservation request message, a refresh interval used by the sender is included." reads better and shorter as "Each ... message includes ..." To which I submit the following article as a rebuttal: http://www.lel.ed.ac.uk/~gpullum/passive_loathing.html . Oh well, at least this person seems somewhat more consistent than most in following his own rule.

There must be places for reasonable use of the passive. Not everything is advertising copy.

One reasonable place is a description of a method ('software was developed') where identifying the actor isn't important.

Active voice is much better in situations such as contracts where the identity of actors is critical (e.g. 'X is responsible for writing the software while Y will maintain the software after delivery')

Re: Common bugs in writing (2021)

#37

> If you find yourself saying "In other words," it means you didn't say it clearly enough the first time. Go back and rewrite the first attempt. Sometimes, particularly in didactic material, it helps to explain things in more than one way, as different people may find different explanations helpful.

It's a good rule for general information presentation.

Tell them what you are going to tell them.

Tell them what you want to tell them.

Tell them what you just told them.

Re: Common bugs in writing (2021)

#38
post #21

Earlier quoted context omitted.

Because they have better things to do than tinkering with the latest HTML technology.

font-size: 1.2rem; that is considered the latest HTML technology?

A lot of sites haven't kept up with best practices. Even HN doesn't (I'm on mobile so I can't double check, but last I did HN uses "pt").

Re: Common bugs in writing (2021)

#39
post #5

I'm a little perplexed as to why professors and other academic staff have routinely hard to read websites. Yes I'm aware I can bump up the font size, but especially on mobile that gets annoying. It's one thing if they don't have a stylesheet what so ever, it's a fully another thing to intentionally make things hard to read: font-family: arial,verdana,sans-serif; font-size: small; From an article that expressly advoca…

You're saying this on a website that I need to manually zoom in to 200% in order to remotely read the text.
Post reply on HN