3 ms·
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 t
by soneca 9y ago
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/ https://writingfordevelopers.substack.com/
- tmaly 9y agoThanks, how often would you send out an email for this newsletter?
- soneca 9y agoMy 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?
- alex_hitchins 9y agoI'm very interested in this - will be signing up. I've been told my specification writing style is good if just a little repetitive. I appreciate it's a technical document and somewhat dry, however keen to see ways I could improve sentence structure. Edit to say : Tips on effective email communication would be good. I seem to either be too brief and appear curt or waffle on where I shouldn't.
- soneca 9y agoThanks, it will the topic next Monday! :)
- tmaly 9y agoIt is a bit longer, but how about a series where you outline writing a good README.md for a github project. This would include the descriptions, examples etc. Many times I will come across a project on github that seems interesting, but there is only a single sentence in the README.md