• snooggums
    link
    fedilink
    English
    arrow-up
    8
    arrow-down
    2
    ·
    5 months ago

    So you started with the need to authenticate, which should be documented in the requirements. You know, the things that are required to happen.

    The details on HOW to authenticate are ALSO documentation. Not all documentation describes functionality.

    • lysdexic@programming.dev
      link
      fedilink
      English
      arrow-up
      3
      arrow-down
      1
      ·
      5 months ago

      So you started with the need to authenticate, which should be documented in the requirements. You know, the things that are required to happen.

      I think you’re confusing documentation with specification.

      Requirements are specified. They are the goals and the conditions in which they are met. Documentation just means paper trails on how things were designed and are expected to work.

      Requirements drive the project. Documentation always lag behind the project.

      • snooggums
        link
        fedilink
        English
        arrow-up
        2
        arrow-down
        2
        ·
        5 months ago

        If you write it down it is documentation. When requirements are written down, they are documented! Requirements are not the same thing as specifications either, but both are documentation!

        You are saying that only technical documentation counts as documentation.

        • lysdexic@programming.dev
          link
          fedilink
          English
          arrow-up
          1
          arrow-down
          1
          ·
          5 months ago

          If you write it down it is documentation.

          I think you’re not getting the point.

          It matters nothing if you write down something. For a project, only the requirements specification matters. The system requirements specification document lists exactly what you need to deliver and under which conditions. It matters nothing if you write a README.md or post something in a random wiki.

          Requirements are not the same thing as specifications either, but both are documentation!

          https://en.wikipedia.org/wiki/System_requirements_specification