Michaël Hompus – Use your source code to document your application – YouTube

“As a development team, writing documentation is often not our favorite activity. And keeping it up to date after every code change is a bigger challenge. Developers claim that the source code is the documentation itself, but do your stakeholders agree, do they actually read the code? And does it show how the part are working together?

What if our source code would be the source of our documentation, for the team and our stakeholders?

In this session we will see how we can utilize Roslyn to generate documentation. Like creating diagrams that display the structure and relationships within an aggregate, or a sequence diagram that displays the flow throughout the application. We will render this using file formats such as PlantUML, Markdown and AsciiDoc.

After this session you will be able to let your source code speak in forms that your team and your stakeholders explain to the operation of your application.”

source

Author: Scottish Summit

Share This Post On