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

Programming

17540 readers
67 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] 19 points 5 months ago (3 children)

Would you rather have working software or a bunch of documentation? If your software is having outages then by definition it is not working. 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 per "working software over comprehensive documentation". Maybe I'm missing something but I don't see the contradiction here.

[–] [email protected] 43 points 5 months ago (2 children)
  1. Hack together a proof of concept
  2. Works well enough that management slaps a “done” sticker on it
  3. Pile of hacks becomes load bearing
  4. One or two dependencies change, the whole thing falls over
  5. Set evenings and weekends on fire to fix it
  6. Management brags about moving fast and breaking things, engineers quit and become cabbage farmers and woodworkers
  7. New graduates are hired, GOTO 1
[–] [email protected] 9 points 5 months ago* (last edited 5 months ago) (2 children)

If 2 and 3 happen the game is up. Management killed it.

That's not agiles fault.

[–] 0x0 5 points 5 months ago

Surely you're not gonna blame the manager.... /s

[–] tyler 1 points 5 months ago

But that’s what agile sounds like to management. They don’t understand the “it’s held together by hopes and dreams” communication, because all they see is something that appears to work. So why would they invest anything else in it.

[–] [email protected] 6 points 5 months ago

This is the most accurate description of anything that's ever been written.

[–] [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

[–] [email protected] 3 points 5 months ago (1 children)

In long term development, sensible and updated documentation is far more important than the software working constantly. You will have downtimes. You will have times before the PoC is ready.

But if your documentation sucks or is inexistent, you cannot fix any problems that arise and will commit a ton of debt the moment people change and knowledge leaves the company.

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

Fair enough, at my job the code working consistently is absolutely the number one priority at all times but I can imagine that there are some places where this is not true. If working software isn't imporant then I agree agile is probably not the right choice

It's worth pointing out though that having insufficient documentation is not a feature of agile. Sounds more like laziness or misplaced priorities to me as documentation is called out as being useful in the agile principles, just not as important as working software.

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

Definitely. Most often it's people misunderstanding the "a over b" of agile as "never do b".