UserDocs
UserDocs is an semi-autonomous way to create end-user documentation for your Rails project.
Installation
- Ensure you have the VERSION constant defined for your project.
- Add this line to your application's Gemfile:
ruby gem 'user_docs'
And then execute:bash $ bundle
- Install the required files:
bash $ rails g user_docs:install
Include the UserDocs module in your system tests:
class ExampleTest < ApplicationSystemTestCase include UserDocs test "foo" do end end
Generate documentation by running your system tests:
$ rails test:system
Push changes to master.
Your documentation should be viewable in the given url within a couple minutes.
Usage
Here are the following methods you can use to create documentation:
accept_alert
click_on
fill_in
choose
save_screenshot
comment
License
The gem is available as open source under the terms of the MIT License.