this post was submitted on 05 Jun 2024
423 points (94.5% liked)

Programming

17540 readers
66 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
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 7 points 5 months ago (2 children)

If documentation is the root cause of that then you should fix that by creating enough documentation to allow your software to continue to work

Or create a better UI that doesn't require so much documentation.

[–] [email protected] 12 points 5 months ago* (last edited 5 months ago) (1 children)

This assumes front-end development.

From a (dev)ops perspective, if I had a vendor hand me a tarball instead of proper documentation, I'd look very far away from their company. It isn't a matter of if shit goes wrong, but when. And when that shit goes wrong, having comprehensive documentation about the architecture and configuration is going to be a lot more useful than having to piece it together yourself in the middle of an outage.

[–] [email protected] 5 points 5 months ago* (last edited 5 months ago)

Yeah, I almost added a clarification for that very point, and see now that I should have.

[–] MajorHavoc 1 points 5 months ago

Or create a better UI that doesn't require so much documentation.

Sacrilege!! /s