this post was submitted on 24 Mar 2024
48 points (84.3% liked)

Programming

17391 readers
169 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev

founded 1 year ago
MODERATORS
snowe@programming.dev
Ategon@programming.dev
MaungaHikoi@lemmy.nz
48
8 Writing Tips for Software Professionals (optimizedbyotto.com)
submitted 7 months ago by otto@programming.dev to c/programming@programming.dev
11 comments fedilink hide all child comments
 

In this post, I share 8 principles I believe in:

  1. Less is more
  2. Start with the solution or the ask
  3. Show the facts, with examples
  4. Always quantify
  5. Include links and references
  6. Explain why it matters
  7. Ask feedback from one person
  8. Sleep on it

As engineers and developers, we often focus heavily on technical skills while neglecting the importance of clear, compelling writing. But the reality is, our ability to communicate effectively can have a major impact on our careers.

you are viewing a single comment's thread
view the rest of the comments
[โ€“] corsicanguppy@lemmy.ca 3 points 7 months ago (1 children)

the ask

This is where the English stopped, so I knew to stop reading.

Please leave the sales-chad jargon to the car lot, if you could.

[โ€“] lolcatnip@reddthat.com 3 points 7 months ago* (last edited 7 months ago)

I'm pretty sure this is precisely the kind of thinking OP is trying to break you out of. If you make it far enough in your career, dealing with people who talk like that will become part of your job. We'd all like to just spend our time coding, but you can't just ignore the people who write your paycheck.