bitovi / documentjs

The sophisticated documentation engine
https://documentjs.com/
MIT License
598 stars 381 forks source link

Ability to expose BDD tests written for a component as part of it’s documentation #223

Open adrifolio opened 8 years ago

adrifolio commented 8 years ago

The use case for this is the following:

  1. A Business Analyst or Product Owner writes the requirements for the implementation of a component using Gherkin syntax
  2. Then, a developer uses this information to write actual Gherkin tests for the component (using Yada for example) and adds it to the component library
  3. Later on another BA, needs to write requirements for the addition of the same component in another place in the app, and would like to know which behavioral scenarios is the component covering.

The idea then, would be to expose the Gherkin scenario definitions (which are human readable) as part of the documentation that is generated for the component.