Within my current project, I use a special C dialect. So, I have to write a lot of explanatory text for those who dare to use it. And even in solo projects, I

Within my current project, I use a special C dialect. So, I have to write a lot of explanatory text for those who dare to use it. And even in solo projects, I have been in situations when I had to check my own docs to understand what's going on. As a result, my project is effectively also a wiki: https://replicated.wiki/abc/ https://replicated.wiki/abc/ https://github.com/gritzko/librdx/tree/master/abc https://github.com/gritzko/librdx/tree/master/abc The idea is to put motivational and explanatory text into the parallel wiki, while all the API docs stay in the code the normal way. These are seriously different things. The next step to unit tests all the code docs. Or, the other way around, to document tests to make them joy to read. That is the only way to solve doc rot. Overall, I am trying to get as close to Literate programming as practically possible: https://en.wikipedia.org/wiki/Literate_programming https://en.wikipedia.org/wiki/Literate_programming Because code is hypertext, IDE is a browser.