Using Cucumber or RSpec+Selenium to create end user documentation?
- by carolclarinet
Has anyone tried creating end user (potentially online, potentially to be printed) help/documentation out of your cucumber scenarios? Or taken screenshots for use in documentation using RSpec and Selenium RC's ability to do so?
For Cucumber, I'm imagining something like:
Scenario: If you want to add a link
Given I am on the edit blog post page
When I press the "add link" button
And I type in a link URL "http://stackoverflow.com"
And I click "OK"
Then the blog post should have 1 link
Translating to the documentation:
If you want to add a link, go to the
edit blog post page. Press the "add
link" button and type a URL, like
"http://stackoverflow.com", into the
link URL field. Click "OK".
Would it be worth my time to try and, for one, write something to parse my Cucumber features into documentation, and two, to write/structure my Cucumber features in such a way as to create good documentation? Would the resulting documentation end up sounding really boring without much variation in the structure?
Is there anything else out there like this idea? Doxygen looks like it's more for code documentation than end-user documentation.
What about automatically taking screenshots? This seems like a more fruitful path-- just reuse the code that takes a screenshot when an RSpec test fails and have it take one in prescribed situations. Is there a better way to do this?
