15 September 2013

RSpec: The Best Example of Living Documentation I've Seen


Here's a beautiful example of Cucumber-based Living Documentation.  Of all things, it's for RSpec, a Ruby testing tool.


https://www.relishapp.com/rspec/


In his book, Specification By Example, Gojko Adzic identifies one of the big benefits  (but not the most important1) of systems like Cucumber is that they can be used to produce Living Documentation.

There's a tool for generating HTML from Cucumber .feature files; it's called RelishApp.


Like anything, it's really about the attitude and aptitude applied to a technique and not the motions themselves that produces a quality result.






1 Adzic makes clear that the most important benefit of SBE is the shared clarity that comes from the collaborative specifying work, itself: that when a subject matter expert, a systems designer and test system designer all work together on defining the spec, the quality of the specification is much greater than what results when these factors are considered in a more serial fashion.

No comments:

Post a Comment