4 ms·
Write a "how this piece of incredibly complicated software works" document for a piece of software you have no idea of the workings. I have never actually publ
by 0xfaded 10y ago
Write a "how this piece of incredibly complicated software works" document for a piece of software you have no idea of the workings.
I have never actually published any, but have done this several times. The process is unlike any other form of writing; you are constantly rewriting all parts to reflect your incremental gains in understanding.
P.S. I believe there is an inversely proportional documentation to complexity rule, where at some point the adequate amount of documentation to describe the complexities becomes unmaintainable. In this case, the code becomes a better descriptor of the code than any amount of documentation ever could.
Examples I've worked with include the go compiler and Scala's slick library.