Document Your Application Using Your Source Code

11 seats available

Thursday morning 10:00 - 12:00 CET (UTC+1)

Speakers

Michaël Hompus

Description

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.

Practical information

The workshop is .NET centered, as it uses Roslyn, but the concepts transfer easily to different languages.

Prerequisites:

  • .NET experience and fluent in C#
  • Knowledy of Roslyn, AsciiDoc, PlantUML
  • Have Visual Studio 2019 and .NET Core 3+
About Michaël Hompus

Software Architect Twitter LinkedIn Blog Company Website

Michaël Hompus is a Software Architect at Info Support. As Software Architect he is part of several teams, realizing new and innovative solutions, preferable using the Microsoft Cloud. Michaël has many years of development experience with .NET, Microsoft Azure, Azure DevOps, Office 365 and Dynamics 365. His passion is to share knowledge, with colleagues, customers and peers.