Re:The Opposite of Documentation is Superstition (2020)
by ValentinA23 on Sunday December 01, 2024 @08:01AM
(#42288242)
Related: Show HN: Auto Wiki – Turn your codebase into a Wiki
Re:The Opposite of Documentation is Superstition (2020)
by VectorLock on Sunday December 01, 2024 @02:46PM
(#42290275)
Someone at work recently introduced a thing that would create git commit messages from code, completely negating the necessity of the programmer to provide accurate not-contained-in-code context. If they weren't across an ocean I would have shook them by the shoulders until they understood.
LLMs can put into words what a programmer can infer from struct definitions, function signatures, names and even taking a cursory look at a function body.
LLMs cannot retroactively find out the _why_ of design choices. If you don't document the reasons behind decisions while making them, they'll be lost, which is exactly what leads to superstition. As a result, changing code is error prone because you never know when code is written in a particular way for a good (and still valid) reason or just because.