Continuous Documentation @JavaLand 2018

Slide 1

Slide 1 text

Continuous Documentation Daniel Kocot (@dk_1977) JavaLand 2018 13.03.2018 1

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

4 Show your hands

Slide 5

Slide 5 text

5 Continuous Delivery Develop Build Test Deploy Release

Slide 6

Slide 6 text

Agilität und Dokumentation 6

Slide 7

Slide 7 text

Agiles Manifest Individuen und Interaktionen mehr als Prozesse und Werkzeuge Funktionierende Software mehr als umfassende Dokumentation Zusammenarbeit mit den Kunden mehr als Vertragsverhandlung Reagieren auf Veränderungen mehr als das Befolgen eines Plans 7

Slide 8

Slide 8 text

Agiles Manifest Funktionierende Software mehr als umfassende Dokumentation 8

Slide 9

Slide 9 text

Dokumentation als Inkrement 9

Slide 10

Slide 10 text

Transparenz 10

Slide 11

Slide 11 text

Verantwortlichkeit 11

Slide 12

Slide 12 text

Review 12

Slide 13

Slide 13 text

Der Kunde im Kontext von Dokumentation 13

Slide 14

Slide 14 text

Lebendige Anforderungen 14

Slide 15

Slide 15 text

Der richtige Inhalt 15

Slide 16

Slide 16 text

Gestaltung 16

Slide 17

Slide 17 text

17 Retrospektive Dokumentationslandschaft Wissensmanagement

Slide 18

Slide 18 text

Werkzeuge 18

Slide 19

Slide 19 text

Documentation as Code 19

Slide 20

Slide 20 text

Asciidoctor 20

Slide 21

Slide 21 text

Slide 22

Slide 22 text

PlantUML 22

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Test Driven Documentation 24 Anforderung mit Gherkin Tests mit Spock Spock Reports

Slide 25

Slide 25 text

API Dokumentation 25 25 swagger2markup Spring REST Docs

Slide 26

Slide 26 text

Buildmanagement & Buildpipelines 26

Slide 27

Slide 27 text

Multi-Channel Dokumentation 27 27

Slide 28

Slide 28 text

Wikis 28

Slide 29

Slide 29 text

Static Site Generators JBake jekyll Antora 29

Slide 30

Slide 30 text

Asciidoctor PDF speedata Publisher 30 Portable Document Format

Slide 31

Slide 31 text

31 Documentation as a Service Spark Framework

Slide 32

Slide 32 text

DEMO 32

Slide 33

Slide 33 text

Weiterführende Informationen •Agile, frisch gebackene Dokumentation – Teil 1: JBake https://blog.codecentric.de/2017/10/jbake-agile-dokumentation-teil-1/ •Agile, frisch gebackene Dokumentation – Teil 2: PlantUML mit JBake https://blog.codecentric.de/2017/11/agile-frisch-gebackene-dokumentation-teil-2-plantuml-mit-jbake/ •Agile, frisch gebackene Dokumentation – Teil 3: Getestete Anforderungen mit JBake https://blog.codecentric.de/2018/02/agile-frisch-gebackene-dokumentation-teil-3-anforderungen-spock-jbake/ 33