Home
Scenarioo is a tool that helps you create an up-to-date software documentation leveraging existing UI tests. This can be an essential part of a "living documentation system" as described by Gojko Adzic in his book "Specification by Example".
With Scenarioo you can document your frontend application from a business and user perspective. Each UI test scenario is documented as a flow of screens. For a better overview, these scenarios are grouped into use cases. This gives a good high level picture of what an application is capable of and what typical scenarios you had in mind when implementing it.
The Scenarioo Viewer web application lets you browse the documentation easily and lets you jump from screen to screen, almost like a cangaroo (therefore our logo).
For a more detailed introduction, visit our web page under http://www.scenarioo.org
These are the parts of which Scenarioo is made of:
-
Scenarioo Documentation Format: A file format and folder structure for storing the automatic documentation of your user scenarios out of UI tests. As a user of Scenarioo you do not need to know much about this exact format, because you probably just want to use one of the existing writer libraries to write this format. If you want to know more details about the format, have a look at the Scenarioo-Writer-Documentation-Format.
-
Scenarioo Writer libraries for different languages (currently Java, C#, JavaScript with WebdriverJS and Jasmine): To generate the Scenarioo documentation files, you need to extend your UI tests (written in e.g. Selenium, Robotium, etc.) so that they store information about use cases and scenarios into a documentation folder. The Scenarioo writer library helps you with this task. The Scenarioo Writer library knows how the documentation data has to be stored on disk, so that you can concentrate on supplying the relevant information. Have a look at How to use a Scenarioo Writer Library to find out more.
-
Scenarioo Viewer web application for browsing the generated documentation: The web app makes the documentation available to anybody that is interested in it. This includes developers, business analysts and even business people. Therefore it let's you easily browse use cases, scenarios and their steps. If you just need to know how to set up the web app, have a look at the Scenarioo Viewer Web Application Setup.
Have a look at our demo: http://demo.scenarioo.org
There are also demo links for next release candidates of Scenarioo that are currently under development, see Downloads & Links.
If you are interested how you can use Scenarioo in your own project, have a look here:
[How to use Scenarioo](How to use Scenarioo)
If you want to contribute to Scenarioo please carefully read and follow the guidelines you find on this page:
Information for Scenarioo Contributors
The Scenarioo Writer library is a core part of Scenarioo. The Java version of this library is the reference implementation. Furthermore we maintain a library for C# and JavaScript. If you want to contribute to one of this libraries or want to start a new Scenarioo Writer library in a different language, you will find most important required information on the following page.