Automated Documentation with UI Tests
An illustrative guidebook through application functionality as a better basis for communication and collaboration between business, development and operations.
Features
Visual Guidebook of User Scenarios
Document the important user scenarios of your application with screenshots and arbitrary additional information generated out of your automated UI tests. The Scenarioo Viewer web app lets you jump, almost like a kangaroo, through the steps of the tested scenarios. These scenarios are grouped by use case for ease of navigation.
For Business, Development and Operations
Everybody involved in the development of your software can use the Scenarioo Viewer to browse the generated documentation comfortably. This is a common source of information and basis for collaboration for product owners, business analysts, product managers, requirements engineers, testers, supporters, developers and operations.
Browse our Wikipedia example documentation at demo.scenarioo.org
Always Up to Date
Scenarioo is a living documentation that is updated whenever you run your UI tests on the build server. Scenarioo turns your UI tests into a functional documentation of your software that is always in sync with what is currently implemented.
UI Testing Toolkit Agnostic
Scenarioo provides a documentation format that is independent of your testing technology. It is possible to write Scenarioo XML files and screenshots from arbitrary UI testing toolkits and programming languages. For your convenience we provide a small Scenarioo Writer library that helps writing the documentation files from your tests written in C#, Java and JavaScript.
Downloads
Scenarioo Viewer
Install the Scenarioo Viewer web application for browsing your generated documentation:
Scenarioo Writer
Use a Scenarioo Writer library in your UI tests to generate documentation.
For Java: Get JAR from Maven-Central
For C#: Get NuGet Package (Instructions)
For JavaScript: Get npm package (Instructions)
For other Languages: Format Documentation to Implement your own writer
How to get started?
Contact
Stay Updated about Scenarioo
To get informed about new software updates, upcoming features and other news around Scenarioo:
Register for the Scenarioo Newsletter
Problems? Questions? Feedback?
We appreciate any feedback that helps us improve our documentation, tutorials, examples and Scenarioo.
Please also report any problems / questions that arise when using Scenarioo.
Simply open an issue on GitHub and we will answer it as soon as possible:
Thanks for your help to improve Scenarioo!