9. Add Living Documentation

⏲️ 5 minutes

In this step you’ll learn how to generate a living documentation from your test execution results.

1- Open a command prompt.
Open Command Prompt

Test quickly if you have the .NET CLI installed.

dotnet --version`

Dotnet Version

2- Install the LivingDoc CLI as a global dotnet tool.

dotnet tool install --global SpecFlow.Plus.LivingDoc.CLI

Dotnet Tool Install

3- Navigate to the output directory of the SpecFlow project. In this example the solution was setup in the C:\work folder.

cd C:\work\SpecFlowCalculator\SpecFlowCalculator.Specs\bin\Debug\netcoreapp3.1

4- Run the LivingDoc CLI to generate the HTML report.

livingdoc FeatureData.json

LivingDoc CLI

5- Open the generated HTML with your favorite browser.

C:\work\SpecFlowCalculator\SpecFlowCalculator.Specs\bin\Debug\netcoreapp3.1\LivingDoc.html

Review the living documentation of the calculator features that you have implemented. Select the “Calculator” feature in the tree. On the right pane check the detailed description of the feature and the scenarios. You can also see the “green” test execution result of the scenarios and steps.
LivingDoc Calculator Feature

Check the test result summary. Click on the “Test Result Summary” tab.
LivingDoc Execution Summary