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

Programming

17669 readers
133 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 [email protected]

founded 2 years ago
MODERATORS
snowe
Ategon
[email protected]
48
8 Writing Tips for Software Professionals (optimizedbyotto.com)
submitted 9 months ago by otto to c/programming
10 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.

all 11 comments
sorted by: hot top controversial new old
[–] [email protected] 15 points 9 months ago
  1. No AI art.
[–] [email protected] 12 points 9 months ago (2 children)

Good tips, but how does one practice them? Often times I see advice along the same lines but no offers on how to improve these skills.

[–] [email protected] 4 points 9 months ago

Write to non technical humans and ask them for feedback, and if it is clear what's goong on even if they dont understand some stuff.

Then do the same with various levels of technical people and different walks of life.

[–] arendjr 2 points 9 months ago (1 children)

I would suggest writing blog posts about topics that you’re familiar with. Make sure you write the posts such that also people not too familiar with the material can follow it. Share your posts, and ask for questions and feedback.

[–] [email protected] 2 points 9 months ago (1 children)

I have been thinking about starting a blog.

Any recommendations for self-hosted blogging? The setup itself might be worthy of a post :)

[–] arendjr 2 points 9 months ago

I use Astro, because it allows me to write posts in Markdown and publish as a static website, though there are certainly other solutions that allow you to achieve the same thing. I just bundle it up in an Nginx Docker image and host it on Fly.io. If you want you can look at my setup here, though beware it isn’t documented (even the README is already out of date): https://github.com/arendjr/phebe

[–] [email protected] 11 points 9 months ago

The last two points, "Ask feedback from one person", and "Sleep on it" I think are great. Ironically the article ignores the rest of its own tips.

  1. Less is more

Circular logic. Q: "how do I write more efficiently?" A: "with less words" This "tip" could be omitted entirely.

  1. Start with the solution or the ask. [...] In ideal cases, the main message you want to convey is already in the title.

Better title: "8 Writing Efficiency Tips for Software Professionals", or maybe "8 Tips for Software Professionals to Communicate More Efficiently"?

  1. Show the facts, with examples

No text extracts provided in the article. For example a rewritten paragraph, or comparison of some summaries.

  1. Always quantify

Always! Except for this article which does not suggest a way to measure the efficiency of text e.g. number of words to convey the same message.

  1. Include links and references

None provided.

  1. Explain why it matters

Why would I want to write more efficiently? What real-world problems does efficient writing solve? Maybe I'm a software engineer new to the field and I don't know how pressed for time some managers are, or how people are drowning in verbose corporate junk words?

Maybe this article was LLM generated, like the cover graphic :(

[–] [email protected] 4 points 9 months ago (1 children)

I don’t think I want to use that laptop.

[–] [email protected] 2 points 9 months ago

Must be one of those new Microsoft AI laptops.