4 ms·
Code is the ultimate reference for understanding a project, while documentation is often neglected, outdated, or incorrect. It can also be difficult to keep up
by jamesrom 4y ago
Code is the ultimate reference for understanding a project, while documentation is often neglected, outdated, or incorrect. It can also be difficult to keep up to date.
An LLM may not fully comprehend the code like the original author, but it can offer a different perspective that may be valuable. The only argument I've seen against LLMs is that it may encourage laziness, but this is a flawed argument similar to those made against the printing press, which was said to make people illiterate.
As a reader of the docs: does it require discipline to refer back to the code when needed. Yes, but this is no different from the discipline required to write documentation in the first place. But with a key difference, the discipline is shifted from author to reader.
- woeirua 4y agoThis just begs the question… why not generate the docs when someone reads the code instead? Why bother generating a bunch of half assed docs today when you can wait and interrogate the code in a much more natural and fluid way using the same LLM when it matters?
- docandrew 4y agoSEO. When you ask an LLM “What’s a good library/tool I can use to accomplish X?” The ones with some documentation already attached will rise to the surface and make it easier for the consuming LLM to generate code samples for.
- IanCal 4y ago1. It's cheaper 2. Everyone can see the same thing 3. It can be utilized for search 4. You can do both Perhaps most importantly 5. It can be reviewed
- ModernMech 4y agoBecause not everyone will have access to LLM technology, and even if they do, your project might not always be used in a setting where access is technically feasible.
- deleted 4y ago[deleted]