Enhancing Software Documentation: Generating Diagrams from Code

Presentation
Software Documentation

14. November
11:30 - 12:15 AM (CET)
C7.2

finished

Marcus Schmidt
- Intershop Communications AG

In software documentation, the docs-as-code approach is widely used to improve efficiency and collaboration. However, handling diagrams made with different tools and formats can be challenging.

This presentation shows how to overcome this by using text-based solutions, namely Mermaid and PlantUML, and how to integrate code-based diagrams into documents via Intershop's online help.

Takeaways

Attendees will get an insight into the docs-as-code process at Intershop Communications AG and learn about different tools for creating code-based diagrams and ways to integrate them in DITA and Markdown files.

Prior knowledge

A basic understanding of docs-as-code is helpful.

Speaker

Marcus Schmidt

Intershop Communications AG

Show profile

Biography

Marcus Schmidt holds a Master's degree in Technical Communication from Hochschule Merseburg and has 6+ years of experience as a Senior Technical Writer at Intershop Communications AG, where he is responsible for the online help, API documentation, and managing software localization. Furthermore, Marcus Schmidt worked as a lecturer at Hochschule Merseburg, teaching fundamentals of software documentation in the bachelor program "Technical Information Design".

Back