3 ms·
I've found that the best aid to keeping a mental model of the structure of a project is to document it well using Literate Programming: http://literateprogramm
by WillAdams 10mo ago
I've found that the best aid to keeping a mental model of the structure of a project is to document it well using Literate Programming:
http://literateprogramming.com/ http://literateprogramming.com/
which then affords a PDF w/ a ToC, indices, and sidebars and other navigational aids all hyperlinked so as to make moving through the code and its documentation quick and fluid.
Then, when I arrive at the section of code which needs to be updated, the documentation and reasoning about its current state is right there.
Not sure if this scales up to multiple developers though....
- son_of_gloin 10mo agoLiterate Programming would also probably help coding assistants understand the code better and generate better output. Or is that the point you are trying to make?
- WillAdams 10mo agoNo, but that's an interesting adjunct. Maybe if that takes hold, LP will finally take off?