Discussion on: What's worse: Stale documentation or no documentation?

[taijidude]

Good question. One thing that comes to mind is diagrams. Granted not perfect, but a good diagram can be okay to maintain and offer clearity. Even better if i can generate it from my Code. But i know the answer is vague.

[Maxi Contieri]

IMHO, Diagrams are for human to human comunication

Used to document sofware is yet another code smell

Code Smell 47 - Diagrams

Maxi Contieri ・ Dec 9 '20 ・ 2 min read

#oop #codenewbie #tutorial #webdev

[Maxi Contieri]

Code Smell 47 - Diagrams

Maxi Contieri ・ Dec 9 '20 ・ 2 min read

#oop #codenewbie #tutorial #webdev

you can add functional tests, contract testing, integration testing, cucumber, BEHAT and so on

All of them are alive and kicking. documentation is dead prose

[taijidude]

Again, disagree but i see your point. Having diagrams doesn't make it automatically good. The main thing that documentation has to do is communicate your ideas, design information to other humans. I'm a visual guy. When i want to understand something or discuss with colleagues i start drawing.

[Maxi Contieri]

I'd love to discuss with you using diagrams since we are both humans

[taijidude]

Okay, my pleasure. ☺️