this post was submitted on 25 Sep 2025

558 points (95.9% liked)

Programmer Humor

26673 readers

1886 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

Keep content in english
No advertisements
Posts must be related to programming or programmer topics

founded 2 years ago

MODERATORS

anzo@programming.dev

Feyter@programming.dev

BurningTurtle@programming.dev

pylapp@programming.dev

558

How I, a non-developer, read the tutorial you, a developer, wrote for me, a beginner - annie's blog (anniemueller.com)

submitted 1 week ago by SmartmanApps@programming.dev to c/programmer_humor@programming.dev

177 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] felbane@lemmy.world 6 points 6 days ago

I think the issue is that you need to understand who your users actually are. Documentation for a library intended to be used by a reasonably competent software engineer is going to have different requirements vs documentation for a cli utility aimed at Arch btw Linux users vs documentation for a program to help Grandma organize family photos.

If you throw a terminal command at Grandma she's going to panic and call her grandchild. If you put instructions for extracting a tarball in your library docs the programmer is going to get bored and skip ahead.