DEV Community

Discussion on: Would you trade your project documentation for updated software architecture diagrams?

Collapse
 
jappyjan profile image
jappyjan

I'd actually say that a documentation is only needed for external api's/interfaces...
A documentation for every single line of code or just every function is just too much. Too much that anyone could make any use of... I actually think that navigating and reading the code should be easy enough to be understood by any developer... If it's not, you should try to code differently.

Collapse
 
functor profile image
Santana16

I agree that you can figure out anything but the question is what amount of time it takes. Developers spend around 60% of time actually writing the code and the rest of the time, it's figuring out the logic and understanding the code.