Session

Docs-as-Code - Create documentation continuously and automatically

In contrast to the classic approaches (word processing, wiki, network drives, ...), Docs-as-Code pursues the goal of treating the documentation relevant in software projects exactly like the source code. Thus, there is no media break for the developing team members. They can use the same tools (text editor, IDE, build tools, CI/CD pipeline) to store the content as lightweight text formats alongside the source code in version management, review the changes together with the sources, mark them as a release and deliver them, and integrate the target group-oriented compilation of the results into the build process. To avoid redundancies, textual content and diagrams can be generated automatically from the existing project models (source code, DB model, UML model, ...).

Any kind of documentation thus gains visibility, and through the integration into the development processes and the associated continuous further development, the quality and thus the acceptance by the readers increases. Documentation can even be executed, for example to test embedded architecture rules regularly in an automated way. In this presentation, the audience will learn how to get started with Documentation as Code, which typical pitfalls they should avoid and which concrete tools should be known.

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