• cmhe@lemmy.world
    link
    fedilink
    English
    arrow-up
    4
    ·
    edit-2
    3 days ago

    Good code documentation describes why something is done, and no just what or how.

    To answer why you have to understand the context, and often, you have to be there when the code was written and went through the various iterations.

    LLMs might be able to explain what is done, with some margin of error, but why something is done, I would be very surprised.

    • dermanus@lemmy.ca
      link
      fedilink
      English
      arrow-up
      4
      ·
      3 days ago

      you have to be there when the code was written and went through the various iterations.

      Well, we don’t have that. We’re mostly dealing with other people’s mistakes and tech debt. We have messy things like nested stored procedures.

      If all we get is some high level documentation of how components interact I’m happy. From there we can start splitting off the useful chunks for human review.