this post was submitted on 05 Jun 2024
412 points (94.4% liked)

Programming

17443 readers
149 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 !webdev@programming.dev



founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
[–] snooggums@midwest.social -1 points 5 months ago (1 children)

Requirements ≠ Documentation.

They are part of documentation, but not all documentation.

[–] vrek@programming.dev 1 points 5 months ago (1 children)

The difference is in exact wording Agile: the software shall properly authticate a user within our active directory.

Documention : user authentication will be provided by functions ”valisate username” as described in section 14,7 subsection 4, ”validate password” as described in section 16.2 and validate the correct pasword as described in section 23.4.Proper authication to the correct use group shall comply with the requirements in document 654689 section 64.7 subsection 17

Yes there is a difference and one is better....

[–] snooggums@midwest.social 6 points 5 months ago (2 children)

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.

[–] atzanteol@sh.itjust.works 4 points 5 months ago

If you need documentation then do documentation. Nothing in the agile methodology tells you not to.

[–] lysdexic@programming.dev 2 points 5 months ago (1 children)

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@midwest.social 0 points 5 months ago (1 children)

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 0 points 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