M8wuccpjm84gv9b6ealq
SkillsCast

Living Documentation for commandline applications - A contract between you and your users

14th April 2016 in London at CodeNode

There are 39 other SkillsCasts available from CukeUp! 2016 - the progressive BDD conference for testers, devs and product owners

Please log in to watch this conference skillscast.

565768981 640

Quite a few books told you that writing tests upfront is a good thing. They're right, but unfortunately you normally also need some documentation about how to use the well tested service/applicaton.

Using "cucumber" makes both possible and "easy": Writing tests upfront, but also generating documentation from those tests. Accompanied with "aruba", you can use it to generate documentation from your tests for commandline applications. This is what cucumber and rspec do for their documentation.

This talk focuses on testing commandline applications and having documentation for those. It starts with thoughts about documentation itself and then gets into problems you might face if you try to convince administrators to document their scripts. It closes with a solution for that task.

YOU MAY ALSO LIKE:

Thanks to our sponsors

Living Documentation for commandline applications - A contract between you and your users

Dennis Günnewig

Dennis Günnewig is a system administrator responsible for a lot of HTTP proxy servers in large customer environments. To make his daily job a little bit easier he writes quite a few scripts and commandline applications. For those scripts and applications which are more complex he uses "cucumber" and "aruba" to write and run a test suite. Besides that he's one of the maintainers of "aruba" and loves to write ruby code.