Updates to SpecFlow+ LivingDoc – LivingDoc goes into Overdrive

SpecFlow+ LivingDoc Generator version 3.5.186 and SpecFlow+ LivingDoc Azure DevOps have just been updated on 12/08/2020. Learn more about our exciting recent changes below.

Quick Summary: 

  • Increased flexibility to generate LivingDoc with different input data at different development stages
  • UI Improvements 
  • Show/Hide Test Results 
  • Unused Step Definitions Report 
  • Step Execution Result Summary 
  • Test Results in LivingDoc AzureDevops 

Get an overview of your features at any point during development

Living Documentation is a concept not only a report. It is supposed to be used at many points during your feature development. For it to be “living” it should find use throughout all development activities and not at a single point in time (e.g. at the end of your sprint to generate a Test Results Report). Introducing Test Results a few months back has evolved it towards this vision and created another reason to generate LivingDoc. We now added a third point in time where generating LivingDoc will provide your team with more insights. These points in time are:

  1. Review/View your Feature Files
    Usually early in or while preparing for a Sprint you are at authoring your specification and formulating your Gherkin scenarios before you are getting to work on implementing the specified functionality in your application. You can generate LivingDoc with nothing but feature files in your Git Repository to review the progress your team has made with that already in a single place.
  2. Review/View your Automation Progress
    Once things are specified in feature files your developers start to work on enhancing the application the features were specified for. At this point some developers or testers can get to work and automate the BDD scenarios. Early in the automation work you may be interested in finding out if your refactoring resulted in any unused step definition classes. To do so you can generate LivingDoc at this point to help give you that overview.
  3. Review/View the health of your Application and Features
    Even later during development – usually towards the end of your sprint – you start building the application and your BDD scenarios can run against it. This is where you can see if your new BDD scenarios work and are properly automated as well as if your older ones still work. Test Results become important. Generate LivingDoc here again to learn more details about how test results relate to your specified features.

Show/Hide Test Results

Test Results in LivingDoc are a great and useful thing but sometimes you only want to browse and read through your specified Features from all your Feature Files. For that reason, we now added the capability to toggle the display of Test Results on and off. So you can focus on browsing through exactly the information you need at that moment.

UI Improvements

While we were at reworking some major parts of LivingDoc we also improved the looks of our UI and made sure Gherkin Steps are clearer to distinguish and stand out more.

Example Tables for Scenarios Outlines got a special treatment from us and can now be navigated and previewed with their data nicely:

Easily find unused step definition classes

We have all run into the impact functional change can have to our SpecFlow projects. As the features change, we need to update our BDD scenarios – the Feature Files and Step Definition Classes. Oftentimes Step Definition Classes, that are not needed or tied to a Feature File anymore due to change we have made, get overlooked. Not any longer. To help with this problem we introduced a “Unused Step Definition” Report to the Analytics Tab of LivingDoc. Browse through your unused classes and decide if they are still needed and should be used and updated or can be deleted.

Learn more about your Step Execution Results

When we introduced our Test Execution Summary Charts we started with Features and Scenarios. But the heart of it are the Gherkin Steps. Without this information it is hard to pinpoint issues but also to judge about the overall project health/progress. With our latest changes we provide a summary across all your Gherkin Steps. With it you can find out how many Steps are still lacking Bindings to Step Definition Classes or other relevant details.

Test Results are now also available for SpecFlow+ LivingDoc Azure DevOps

With the introduction of SpecFlow+ LivingDoc Generator we created a handy tool that allows our non Azure DevOps users to enjoy LivingDoc standalone and outsite of Azure DevOps. This allowed us more easily and swiftly to provide additional information in LivingDoc – such as Test Execution Results of your SpecFlow Feature Files. Based on very positive user feedback we decided to stick to the idea of providing Test Execution information in LivingDoc. However, it was never our long-term intent to create a wide functional gap between our 2 flavors of LivingDoc. So, we are glad to announce that this gap has been closed and Test Execution Results down to Gherkin Step Level are now also available for SpecFlow+ LivingDoc Azure DevOps.

Migrating SpecFlow+ LivingDoc Generator v3.4 to v3.5 

LivingDoc Generator has now more flexibility to be also used without Test Execution Results data available. Due to these enhancements your command line arguments need to be changed. Please consult our migration guide to learn more about these changes.

Want to give it a try? Go ahead and get LivingDoc Azure DevOps or Generator for free. Just install it and enjoy.

Interested to learn more about SpecFlow+ LivingDoc and these recent changes?