Dokumentation & Slides mit Git, Gradle, AsciiDoc und Reveal.js

Softwareentwicklung ist mehr als nur Code schreiben, ein wichtiger Aspekt ist auch die Dokumentation. Wer kennt die folgenden Probleme?

* Es gibt zwei oder mehr Branches des Sourcecodes (z.B. Prod und Entwicklung, oder Version 1 u. Version 2), aber nur eine Version der Dokumentation.
* Die Dokumentation wird in völlig ungeeigneten Formaten wie MS-Word erstellt.
* Die Dokumentation enthält Code-Beispiele, aber ob die zum aktuellen Sourcecode passen, ist eher zweifelhaft.
* Wenn mehrere Versionen der Dokumentation existieren, ist es eine Übung in Softwarearchäologie herauszufinden, was die Unterschiede sind und wie sie zustande gekommen sind und ob es nur ästhetische Korrekturen, Bugfixes in der Dokumentation oder Dokumentation von verändertem Verhalten sind.

Dabei gibt es in der Softwareentwicklung mit Versionsverwaltung, automatischen Tests, Stylesheets und dergleichen diverse Tools, um solche Probleme zu lösen.

In diesem Vortrag stelle ich eine Kombination aus Tools vor, mit der sich die Verwaltung und Erstellung von Dokumentation sauber in die Entwicklung von Sourcecode integriert, namentlich: Git, Gradle, AsciiDoctor und Reveal.js, die auch für die Erstellung der Slides für diesen Vortrag genutzt wurden.

Dienstag, 28.03.2017
08:30 - 09:10
Quantum 3+4
Fortgeschritten
Deutsch
IDE & Tools
Demo
Schauder

Jens Schauder

Pivotal Software, Inc.
Jens Schauder ist Softwareentwickler aus Leidenschaft. In Zeitschriftenartikeln, seinem Blog, Konferenzvorträgen oder seiner Mitarbeit bei der JUG Ostfalen versucht er die Welt der Softwareentwicklung ein klein wenig besser zu machen. Besonders wichtig ist ihm dabei die Vielseitigkeit der Softwareentwicklung: Vom Fachwissen, über Programmiersprachen, Bibliotheken und Tools bis zu Vorgehensmodellen. Alles gehört dazu und kann verbessert werden. Seine meisten Vorträge drehen sich um die Themen Scala, Clean Code und Testen. Seit 2017 arbeitet Jens Schauder für Pivotal Software im Spring Data Team. In seiner Freizeit arbeitet er an Degraph einer Bibliothek zur Visualisierung und dem Test von Package Abhängigkeiten.

Weitere Vorträge, die Sie interessieren könnten

Müssen sich Feature Branches und Continuous Integration widersprechen?
28.03.2017
Quantum 3+4
11:00 - 11:40
Steffen Schluff
Schatten der Vergangenheit - Analyse von Git-Repositories
28.03.2017
Wintergarten
11:00 - 11:40
Dirk Mahler
Lesbare Tests mit AssertJ
28.03.2017
Quantum 3+4
12:00 - 12:40
Gorge Albrecht
Produktiver programmieren - Aha-Erlebnisse mit Multi-Clipboards, Application Launcher und Editor-Shortcuts
28.03.2017
Wintergarten
12:00 - 12:40
Dominik Hirt
AsciiDoctor mal Groovy
28.03.2017
Eventhalle
14:00 - 14:40
Stephan Classen