this post was submitted on 03 Aug 2023

491 points (100.0% liked)

Programmer Humor

19564 readers

1413 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 1 year ago

MODERATORS

Feyter@programming.dev

anzo@programming.dev

BurningTurtle@programming.dev

pylapp@programming.dev

491

Why is it so hard finding up-to-date docs and guides? (media.kbin.social)

submitted 1 year ago by BlueKey@kbin.social to c/programmer_humor@programming.dev

45 comments fedilink hide all child comments

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

[–] jrandiny@lemmy.world 16 points 1 year ago (2 children)

This is why having a dedicated person/team to maintain docs is very important

[–] Dharkstare@kbin.social 13 points 1 year ago

I've always felt that programmers need one day out of the week where they explain what their code does to someone dedicated to writing documentation. That way the code is being documented while you still understand what it does and the documentation is constantly being updated.

[–] Gecko@lemmy.world 7 points 1 year ago

Also why having doc comments and docs generated from code are super useful. When someone changes the code but not the comment above, it becomes really obvious that something was missed as opposed to having code and doc changes be two separate tasks.