News for hackers. Stuff that matters.
Re:Ask HN: Is there a better way to document complex softwar... by mattlondon on Sunday November 25, 2018 @04:33PM (#18529192)
UML Sequence diagrams are useful, if they are kept up to date and reflect reality. I find they are great for the initial "what the hell is this doing?" stage of coming to something new.
Re:Ask HN: Is there a better way to document complex softwar... by xtracto on Monday November 26, 2018 @02:03PM (#18535870)
The best way I like documentation is via a docs/ directory within the repo. Uing js-sequence-diagrams ( https://bramp.github.io/js-sequence-diagrams/ ) to create self-contained one page diagrams (like this https://jsbin.com/jusiyusowu/edit?output ) which go into code.

That allowed me to include documentation updates in the code review.