Living software documentation

Software documentation has always haunted me some way, and I have for a long time been fascinated with Donald Knuth’s ideas about “literate code”. Well, I figured, why not “literate documentation” instead? Implying that the documentation for your system, is allowed to execute computing instructions, within its “reader”? This would allow me to create tutorials, that literally “creates themselves”, since the documentation can “reach into the systems its documenting”, and modify the state of it.

In the video below, I am demonstrating how such a documentation system can be created, and more specifically how it will be done, in the upcoming release of Hyper IDE. The advantages are obvious, I think. If you can’t wait, and want to try out Hyper IDE today, even without the “literate documentation parts”, you can download Hyper IDE here. Or you can try out my documentation system here.

Advertisements