Live data from Hacker News

Ask HN: What are good writing tips for software developers?

news.ycombinator.com

21–30 of 70 posts

Re: Ask HN: What are good writing tips for software developers?

#21
post #19
post #11

Earlier quoted context omitted.

As a developer who received regular positive feedback on the quality of my writing, I am starting a side-project to help developers like you. :) This post is to try to get a more diverse opinion on what constitutes good writing outside of my bubble. Please check the kick-off post, maybe you find it useful: https://writingfordevelopers.substack.com/

Thanks, how often would you send out an email for this newsletter?

My plan is to send it weekly, but with shorter texts than this first one.

The idea is to be more specific, like: "Tips for a good Pull Request description", "Tips for a good feature deploy announcement email", "Tips for a good user story".

What do you think? Any topic you are particularly interested?

Re: Ask HN: What are good writing tips for software developers?

#23

If you're an emacs user, try https://github.com/bnbeckwith/writegood-mode

> writegood This made me wince. I know it's perfectly acceptable American but that one's definitely a low blow for an aging Englishman.

I'm fairly certain that the name of the project is tongue-in-cheek; it's not uncommon to use "${X} good" as a comedic expression of poor English. For example, "I done code good."

Re: Ask HN: What are good writing tips for software developers?

#24
Writing improves from improved comprehension resulting from increased reading, writing, conversation.

So, make sure you are getting better at understanding the needs of the user and communicating them.

Have conversations with users - Solve problems that you have and make it available to others.

Solve others problems by learning about them and helping them.

Re: Ask HN: What are good writing tips for software developers?

#26
A 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 and you're.

There are two many people doing it wrong too get to upset about confusion over to, too and two.

Re: Ask HN: What are good writing tips for software developers?

#28
post #6

Some general pieces of advice that I think apply to all writing: - Write like you would speak. Think of your writing as an extended conversation with other developers. - Use the active voice wherever possible. - Strive for clarity and simplicity over overly-complicated industry babble. The smarter you try to sound, the harder you will fail. Of course, there will be some amount of jargon you will rely on, which is fin…

> read good writing That's sort of a Catch-22 right there. Can you tell if "your favorite SF novel" represents good writing without having a grasp on what constitutes good writing to begin with? Is writing like cooking (where you don't really need to cook well yourself to be able to tell)?

"Can you tell if "your favorite SF novel" represents good writing without having a grasp on what constitutes good writing to begin with?"

I think for the purposes at hand, you don't need any expertise in writing to tell whether you want to write short emails with some stuff lifted from a given author.

The larger structural aspects of writing a good novel are overlooked by a lot of people, and a lot of people will declare someone a "good author" when every character in their stories are an author stand-in, things appear and disappear for no reason, there is no symbolic or mythic resonance in the story, and every other major structural error that can be made, simply because they like the sentence-by-sentence style of the author or the author has snappy wordplay that they like. That taste is more rare, but also only slightly relevant to the question of whether you can write a 500-word email to the executive team about how important it is to not cut your project.

Post reply on HN