Always proofread what you write. Always. Even if it’s a short text message or a giant email.
Never write a giant email. Nobody's going to read it.
Ask HN: What are good writing tips for software developers?
51–60 of 70 posts
Re: Ask HN: What are good writing tips for software developers?
#52Lots of good advice here. Here are a few more basic tips:
1. Read it out loud when you're done. If it doesn't sound right, change it so that it does.
2. For the love of everything grammatical, please learn how to use apostrophes properly. Especially its/it's, your/you're, and yours. "It's" always means "it is." "You're" always means "you are." "Your's" is not a word.
3. There is no shame in using a spellchecker. (There is often shame in not.)
4. Know your audience. Don't use technical terms if you're writing for non-technical users and don't dumb it down for a technical audience.
5. Be concise. There's no need to prove you can use a dictionary or thesaurus to stretch out a sentence or to try to sound more intelligent than you need to be (it doesn't work anyway).
If you want a friendlier guide to grammar than some of the other books listed in this thread (which you should also consider adding to your reference library), check out Grammar Girl's Quick and Dirty Tips for Better Writing by Mignon Fogarty https://www.amazon.com/Grammar-Girls-Quick-Better-Writing/dp...
Re: Ask HN: What are good writing tips for software developers?
#53I recommend getting three books and to begin writing at least 500 words per day distraction free (technical, fiction, stream of conscious): 1) On Writing Well - William Zinser https://www.amazon.com/Writing-Well-30th-Anniversary-Nonfict... 2) On Writing - Stephen King- https://www.amazon.com/Writing-10th-Anniversary-Memoir-Craft... 3) The Elements of Style - Strunk & White - https://www.amazon.com/Elements-Style-Four…
I am reading " Style: Lessons in Clarity and Grace ", have you read this? EDIT: link to the book: https://www.amazon.com/Style-Lessons-Clarity-Grace-12th/dp/0...
It's much more useful then Strunk & White in my opinion.
Re: Ask HN: What are good writing tips for software developers?
#54A preposition is a very bad word to end a sentence with. But only a fool would begin or end a sentence with the word but. And only a total idiot would begin or end a sentence with the word and. Anyway, you should never use the word 'anyway'. Even worser to use 'anyways'. And never utilize the word 'utilize' when you could utilize the word 'use' instead. Your doing it wrong if you're sentences confuse the words your a…
Agreed. Also complete sentences.
and capitalization
Re: Ask HN: What are good writing tips for software developers?
#55Re: Ask HN: What are good writing tips for software developers?
#56Re: Ask HN: What are good writing tips for software developers?
#57A preposition is a very bad word to end a sentence with. But only a fool would begin or end a sentence with the word but. And only a total idiot would begin or end a sentence with the word and. Anyway, you should never use the word 'anyway'. Even worser to use 'anyways'. And never utilize the word 'utilize' when you could utilize the word 'use' instead. Your doing it wrong if you're sentences confuse the words your a…
>A preposition is a very bad word to end a sentence with.
"Ending a sentence with a preposition is something up with which I will not put."
Re: Ask HN: What are good writing tips for software developers?
#58The two pieces of writing feedback I've received that I often regret not following: - 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 u…
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?
#59The two pieces of writing feedback I've received that I often regret not following: - 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 u…
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.
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.
Re: Ask HN: What are good writing tips for software developers?
#60A preposition is a very bad word to end a sentence with. But only a fool would begin or end a sentence with the word but. And only a total idiot would begin or end a sentence with the word and. Anyway, you should never use the word 'anyway'. Even worser to use 'anyways'. And never utilize the word 'utilize' when you could utilize the word 'use' instead. Your doing it wrong if you're sentences confuse the words your a…
Yes. Definitely agree about use of "utilize." It is a total tell in any piece of writing that is trying to sound "fancy" for nothing. The person who wrote the text loses one star of my respect rating immediately at the first occurrence of "utilize." It's even worse when spoken!