Anti-Patterns in Software Blogging

7 days ago by codeinabox to c/programming

Effective writing for software developers
JakenVeina 4 points 6 days ago

Minimize assumptions about the readerโ€™s background knowledge.

EVERYONE who writes for an online publication needs tobhave this drilled into them. I feel like a good third of the articles and such that I read suffer from this problem, and yeah, it's ESPECIALLY prevalent in software and tech.

path: 0 26236863, hotness: undefined, score: 4, children: 1
calcopiritus 3 points 5 days ago

At some point you have to assume some kind of knowledge though. If you have to explain everything from the basics, the moment a concept is slightly complicated, the blog gets thousands of pages long.

You don't need to explain how an integer is represented in binary in memory in a blog post about atomic integers. Most people that read about atomic integers already know how integers are represented in memory.

path: 0 26236863 26267745, hotness: undefined, score: 3, children: 0
plc 2 points 7 days ago

Recipe blogs also suffer similar anti-patterns.

For all the trappings of AI, I count cooked.wiki a blessing there.

path: 0 26235282, hotness: undefined, score: 2, children: 0
BradleyUffner 1 point 7 days ago

"sequel"

path: 0 26233966, hotness: undefined, score: 1, children: 0
programming
programming

@programming.dev

login for more options
28819
3722
3326

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


go to feed...