Session

Best practices for keeping architecture documentation up to date

Explicit software architecture is the guarantee for successful software projects. Sufficient and up-to-date documentation is needed to support communication. The docs-as-code approach provides support by bringing the documentation closer to the source code in the form of lightweight text and graphic formats, storing it in the version management system, and editing it with developer tools (IDE/text editor, build tools, CI/CD pipelines) and integrating it into the software development processes.

The presentation introduces easy-to-use methods, templates, and tools that are used to create high-quality, self-validating software documentation. We look at approaches such as Docs-as-Code, lightweight text formats, storage in version management, and embedding in the build and review processes. Making software architecture concepts visible in the code and integrating software analysis tools enable the continuous comparison of target and actual structures and bring architecture documentation to life.

Falk Sippach

embarc

Darmstadt, Germany

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