Man kann zwar an vielen Stellen nachlesen, wie man Architekturdokumentation strukturiert. Aber auf der Suche nach einer praktikablen Handhabung zur Erstellung und Pflege enden die meisten Versuche in der WYSIWYG-Hölle einer Textverarbeitung oder im tiefen Schlund eines Wikis. In diesem Vortrag wollen wir uns anschauen, wie aufbauend auf bestehenden Tools und Textformaten eine möglichst redundanzfreie Dokumentation erstellt und für verschiedene Zielgruppen in ansprechenden Formaten ausgeliefert werden kann. Es wird dabei um Begriffe wie Continuous Documentation und Documentation as Code gehen.
Vorkenntnisse
Softwareentwickler und Architekten, die nach besseren Möglichkeiten suchen, die Architektur ihres Systems zu dokumentieren.
Lernziele
* Dokumentation ist wichtig.
* Dokumentation muss aber auch Spaß machen.
* Dokumentation muss sich in den Entwicklungsprozess integrieren.
* Dokumentation muss leicht nachvollziehbar sein.
* Dokumentation muss möglichst im Team bearbeitbar sein.
hat über 15 Jahre Erfahrung mit Java und ist bei der Mannheimer Firma OIO Orientation in Objects GmbH als Trainer, Software-Entwickler und Projektleiter tätig. Er publiziert regelmäßig in Blogs, Fachartikeln und auf Konferenzen. In seiner Wahlheimat Darmstadt organisiert er mit Anderen die örtliche Java User Group.