Disclaimer : I am a hobbyist programmer, I have not gone to Uni for that , so I might not know everything I am talking about.

My question is why don’t open source programs include something like diagrams of the algorithms they employ ?? I Was looking for algorithms for a chat program with client-server architecture, I was hoping to find diagrams and descriptions of how algorithms work, so a to study them an adapt them to my needs. All I found were FOSS projects with no such documentation.

Considering that reading source code can take a long time, and sometimes interesting projects are written in a language the user isn’t familiar with, I was wondering why such documentation style doesn’t exist ? It could help even newer contributors get started quicker.

  • NullPointer@programming.dev
    link
    fedilink
    arrow-up
    23
    ·
    1 year ago

    “algorithm” is a little too fine grained for what you describe. “software design patterns” is probably what you are looking for.

    unfortunately, not all projects call out the patterns they employ.