zlacker

[parent] [thread] 5 comments
1. saagar+(OP)[view] [source] 2025-12-06 15:59:44
Documentation is one place where humans should have input. If an LLM can generate documentation, why would I want you to generate it when I can do so myself (probably with a better, newer model)?
replies(3): >>simonw+ba >>ACCoun+qa >>ameliu+Qe
2. simonw+ba[view] [source] 2025-12-06 17:19:29
>>saagar+(OP)
I definitely want documentation that a project expert has reviewed. I've found LLMs are fantastic at writing documentation about how something works, but they have a nasty tendency to take guesses at WHY - you'll get occasional sentences like "This improves the efficiency of the system".

I don't want invented rationales for changes, I want to know the actual reason a developer decided that the code should work that way.

3. ACCoun+qa[view] [source] 2025-12-06 17:22:14
>>saagar+(OP)
That's great if those humans are around to have that input.

Not so much when you have a lot of code from 6 years ago, built around an obscure SDK, and you have to figure out how it works, and the documentation is both incredibly sparse and in Chinese.

4. ameliu+Qe[view] [source] 2025-12-06 17:58:28
>>saagar+(OP)
Because it takes time and effort to write documentation.

If people __can__ actually read undocumented code with the help of LLMs, why do you need human-written documentation really?

replies(2): >>baq+qC >>gr4vit+eN
◧◩
5. baq+qC[view] [source] [discussion] 2025-12-06 21:20:59
>>ameliu+Qe
Docs are a form of error correcting coding for code. Docs+code allows you to spot discrepancies and ask which one is the intended behavior.
◧◩
6. gr4vit+eN[view] [source] [discussion] 2025-12-06 22:58:14
>>ameliu+Qe
It doesn't need to be written by a human only, but I think generating it once and distributing it with source code is more efficient. Developers can correct errors in the generated documentation, which then can be used by humans and LLMs.
[go to top]