Session

Use your source code to document your application

For many development teams, writing and updating documentation can feel like a chore, especially when the codebase changes frequently. While developers often consider the source code as its own documentation, this perspective might not resonate with all stakeholders. Moreover, the source code might not adequately illustrate how different components interact.

What if we could transform our source code into comprehensive documentation that benefits both the team and stakeholders?

In this session, we will explore how to leverage Roslyn to generate documentation directly from your .NET source code. We'll delve into creating diagrams that depict the structure and relationships within an aggregate and sequence diagrams that illustrate the flow throughout the application. We'll render these using file formats such as PlantUML, Mermaid, Markdown, and AsciiDoc.

By the end of this session, you'll be equipped to let your source code articulate the operation of your application in a format that is accessible and meaningful to your team and stakeholders.

Key Takeaways:
* Learn how to use Roslyn to interpret your source code.
* Understand how to create and render diagrams that depict the structure and flow of your application.

Length: preferable 45-70 mins
Audience: dotnet, c# background helps, not required
Keywords: Documentation, Roslyn, dotnet, C#, DDD

Michaël Hompus

Architect @ Info Support | Microsoft MVP

Nijmegen, The Netherlands

Actions

Please note that Sessionize is not responsible for the accuracy or validity of the data provided by speakers. If you suspect this profile to be fake or spam, please let us know.

Jump to top