Die IT Tage sind eine Konferenz für Softwareentwicklung,
Architektur, Datenbanken und Management. Wie viele andere Konferenzen findet sie in diesem Jahr online statt.
Mit unseren Beiträgen zu AsciiDoc und ArchUnit gibt es zwei Vorträge der msg im Programm. Beide Vorträge richtigen sich vorrangig an Entwickler und Architekten.
Titel: Dokumentation in der IDE schreiben? Klar, mit AsciiDoc!
Die Prinzipien von Documentation-as-Code sind erfüllt, wenn für die Erstellung von Dokumentation die normale Entwicklungsumgebung genutzt wird, Zusammenarbeit und Reviews über die Versionsverwaltung erfolgen und der Continuous-Integration-Server nicht nur die Software, sondern auch die Dokumentation baut. Im Gegensatz zu Office-Dokumente oder Wikis ist Dokumentation so in den normalen Entwicklungs- und Review-Prozess integriert. AsciiDoc ist eine leichtgewichtige Markup-Sprache, aus der automatisiert zum Beispiel HTML- oder PDF-Dokumente erstellt werden können. In der Entwicklungsumgebung sorgen Plugins für ein Schreiben mit Vorschau-Fenster. Bei jedem Commit in der Versionsverwaltung wird nicht nur die Funktionalität des Programms weitergeschrieben, sondern auch die Architektur-, Entwicklungs- oder Benutzerdokumentation.
Dies ist ein Vortrag für Einsteiger: Nach einer kurzen Einführung zu AsciiDoc setzen die Teilnehmer kleine Texte in AsciiDoc unter Anleitung des Vortragenden um. Hierbei kommt eine Web-IDE zum Einsatz, so dass die Teilnehmer nur einen Browser für die Teilnahme benötigen.
Titel: Mit ArchUnit den Wildwuchs eindämmen
Das Entwicklungsteam hat sich auf Namenskonventionen für Klassen und Pakete geeinigt. Und letztens fiel beim Code-Review wieder die eine Klasse auf, die öfter falsch benutzt wird und damit zu Fehlern führt. Solange dies nur auf einer Wiki-Seite steht, sind automatische Prüfungen nicht möglich. Werkzeuge, die aus diesen Regeln Dashboards erzeugen, sind auf den ersten Blick schön anzuschauen, geraten jedoch bald in Vergessenheit. Die Bibliothek ArchUnit erlaubt es dem Entwicklungsteam, Regeln als Java-Code zu schreiben und sie wie andere Unit-Tests auszuführen. Entwickler können sie jederzeit lokal vor dem Commit ausführen. Der Continuous-Integration-Server führt sie zusammen mit den anderen Unit-Tests aus. Schlagen die Tests fehl, so weist eine verständliche Meldung auf das Problem hin.
Dieser Vortrag zeigt, wie Architektur- und Best-Practice-Regeln als ArchUnit-Tests geschrieben werden. Er vergleicht ArchUnit mit anderen Werkzeugen und zeigt Vor- und Nachteile auf.
Referent: Alexander Schwartz