JCON WORLD ONLINE 2023

Documentation is often neglected. With the docs-as-code approach, the documentation relevant in software projects is treated exactly like source code, stored in version management, edited with lightweight developer tools (IDE/text editor, build tools, CI/CD pipelines) and integrated into the software development processes. Content can be managed without redundancy and some information can be generated from models or source code. The use of lightweight text and graphic formats makes it easy to compile the results in a target group-oriented manner. Processing is automated via the already existing build processes.

Any kind of documentation thus gains visibility, and by integrating it 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 in an automated way on a regular basis. In this presentation, the audience will learn from concrete examples how they can get started with Documentation as Code, which typical pitfalls they should avoid and which concrete tools they should best work with.