Re:Ask HN: What are good writing tips for software developers?
by Daft_but_happy on Monday March 05, 2018 @02:19PM
(#16523582)
You could actually drop the it in the last sentence... :-)
Re:Ask HN: What are good writing tips for software developers?
by shubhamjain on Monday March 05, 2018 @11:55PM
(#16526950)
These prescriptive writing tips do more harm than good. The crucial question is not whether you have adhered to all the tips but if what you wrote sounds good. Following writing advice without critically analyzing it often leads to writing which feels overdone.
Re:Ask HN: What are good writing tips for software developers?
by eropple on Tuesday March 06, 2018 @12:29AM
(#16527077)
I can write you a sentence that sounds amazing. I can also write it with an unclear pronoun antecedent and make a hash of its meaning.
When you know how to write, you can break the rules. Until you do, guard rails keep you from looking like an idiot.
- Most adverbs are superfluous. I am as guilty of ignoring this as anyone, but most cases where you say "generally" or "usually" you're undermining your point and the use of "very", "extremely", etc. are hyperbolic and breathless and make it easier to regard what you're writing as unserious.
- Avoid pronouns unless the antecedent is unmistakable. The use of "it" should immediately be a reason to re-read that sentence and the one before it for clarity.