Test driven documentation

Post on 16-May-2015

842 views 0 download

description

Given by Peter Neubuaer at OSON 2012:You know the drill – prototype, code, test, docs. The last part of the chain is either omitted or will rot in Wikis and manuals. At Neo4j, we made the painful switch from wiki-hell to a totally code – backed manual that is driven by unit tests, a documentation toolchain and part of our build artifacts. Graph images, code snippets, live REST calls and everything. And still not getting in the way of the developers. We are now writing test code that is fit for publishing as blog links to parts of the manual. And developers are looking at the manual to see if the tests make sense. Want that? Hell yeah

Transcript of Test driven documentation