Session

Gebruik je broncode als documentatie voor je stakeholders

Als ontwikkelteam is het schrijven van documentatie vaak niet onze favoriete activiteit. En het up-to-date houden na elke codewijziging is een nog grotere uitdaging. Ontwikkelaars beweren dat de broncode de documentatie zelf is, maar zijn stakeholders het daarmee eens, lezen ze eigenlijk de code?
Wat als onze broncode de bron van onze documentatie zou zijn, voor het team en onze stakeholders?

In deze sessie gaan we kijken hoe we Roslyn kunnen gebruiken om documentatie te genereren. Denk hierbij aan het maken van diagrammen die de structuur en relaties weergeven binnen een aggregate of een sequence diagram die de flow door de applicatie kan weergeven.

We duiken de code in waarbij we kijken hoe we projecten en solutions kunnen laden, syntax trees kunnen gebruiken om de structuur van onze source code te doorlopen en branching logica detecteren om alternatieve paden vast te leggen. Daarna zullen we deze gegevens weergeven naar andere bestandsindelingen zoals PlantUML, markdown en AsciiDoc.

Na deze sessie ben je in staat je broncode te laten spreken in vormen die je team én je stakeholders de werking van je applicatie haarfijn uitlegt.

Lengte: bij voorkeur 45-70 mins
Publiek: dotnet, c# achtergrond helpt
Keywords: Documentatie, Roslyn, Dotnet, C#, DDD

Michaël Hompus

Architect @ Info Support | Microsoft MVP

Nijmegen, The Netherlands

View Speaker Profile