Replying to Avatar Diligent Ninja

If your documentation falls out of sync with the production code you're introducing an unnecessary nightmare for whoever may need to update or maintain the code in the future (which may end up being YOU)
Avatar
Ingwie Phoenix (aka. birb) 2y ago

Normal documentation (think ReadTheDocs) are totally fine and I see them as one of the highest priorities next to integration and unit tests.

But flowcharts...?

Reply to this note

Please Login to reply.

Discussion

Avatar
Diligent Ninja 2y ago

I'm old enough that when I was taught, flowcharts and pseudocode were considered equally sufficient documentation of what the code was supposed to be doing, and simple enough to be easily understood.

But I'm literally a dinosaur in this field (pre-Y2K) so what do I know