Executable Documentation for everyone (even you)

Nikolas Martens

Sometimes good documentation makes the difference between just another dead github repository and a successful, widely used library. But writing documentation is tedious and boring and maintaining it ten times so. But wrong documentation is sometimes worse than none so updating it is even more important than writing it.

If only there was a way to write documentation of software systems that validates itself, making sure it doesn't lies. But wait, there is! Every automated test program is a piece of self-validating documentation. The only thing missing now is a way to make it accessible and understandable for everybody, not only technical experts. This is where 'dox' comes into play - a tool that publishes test code in a pleasant-to-read form. So let me show how, together with some good engineering practices, your wildest (documentation) dreams can come true.

Related

Download

Embed

Share:

Tags