Hello, I'm working on the small project which dedicated to convert BDD tests to Living Documentation. I know there is similar projects, but i want to concentrate not on quality of tests, rather than how your product works.<p>I'm on the very start stage, but you know when you work on something that you feel cool, you always can't wait to share it.<p>Here few links:
How Reek's documentation looks - https://documentation.world/public/projects/2<p>P.S. If you have BDD tests, and want to try don't hesitate.
Love the idea to generate docs from BDD tests, as this can help with document driven development.<p>Since this is a tool for engineers, if you put install and usage examples in code in the docs, then it’s gonna help new users see how to get started quickly and how to use the features. Right now, it looks like a nice way to list features and see a green if the test passes, but it’s not helping the reader/user of the docs to use those tested behaviors from their perspective.<p>if the test code were automatically snippet’d inside those test blocks, then the reader who wants to use some behavior, can find that section, click on the test, and look at how you wrote the code to test it. Then all we have to do is write the test code the same way the user would write their code to use a service, and the docs will automatically have usage examples (the test code snippets)<p>A search box can help to filter the behaviors, especially since they’re nested, because nesting can reduce visual clutter but force you to spend time expanding many sections. Links to the repo code for both the tests and the implementation can help us jump into the process faster.<p>Cool project keep it up!
BDD is a great idea in theory. In practice, the tests often become deeply nested in contexts, rely on shared state and can be very difficult to read. xUnit style tests are not perfect but the best choice for readability and maintainability