• Aurenkin@sh.itjust.works
    link
    fedilink
    arrow-up
    26
    ·
    6 months ago

    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.

    • becausechemistry@lemm.ee
      link
      fedilink
      arrow-up
      42
      ·
      6 months ago
      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
    • AwkwardLookMonkeyPuppet@lemmy.world
      link
      fedilink
      English
      arrow-up
      9
      ·
      6 months ago

      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.

      • pivot_root@lemmy.world
        link
        fedilink
        arrow-up
        11
        ·
        edit-2
        6 months ago

        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.

    • Carighan Maconar@lemmy.world
      link
      fedilink
      arrow-up
      4
      ·
      6 months ago

      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.

      • Aurenkin@sh.itjust.works
        link
        fedilink
        arrow-up
        1
        ·
        6 months ago

        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.