"Oh, documentation? We don't write documentation. Our tests are our documentation."

Sure - I guess your developers are computers, too.

  • 2
    Don't get me wrong. I don't say you never need documentation. But wherever you can replace documentation with code, do it. If it works it will never outdate.

    For instance write a Docker file instead of server requirements. That's code that documents it while in use.

    Tests are often great documentation. Unit tests tell you how a function is supposed to behave down to the corner cases.

    And when something changes, you actually update it nothing is worse than relying on outdated documentation
  • 0
    At least tests are there so you know if the methods are working as they should.. what should you do if all you have is functional documents and no details on how they are implemented. You go about writing a class and find out 3 weeks later that the five methods you wrote in that class actually already exist scattered around in classes having drastic naming distinctions.
  • 1
    @TheCommoner282 my same thoughts. Couldn't agree more.
  • 0
    @TheCommoner282 yeah I agree completely. This came about when there was some weird logic happening within the space of a few lines. I asked why the code seemingly repeated itself and the response was "oh, it gets rid of onboarding screens...". At a certain point, code comments should be considered
  • 0
    @mgarg we don't live in a world where you can only have docs OR tests ;) por que no los dos.
  • 0
    @j2k4 agreed! Let's just say that crappy methodology used by our predecessors is coming to bite us in our bottoms.
Add Comment