31
Continuous Documentation Daniel Kocot (@dk_1977) bed-con 2017 22.9.2017 1

continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

  • Upload
    others

  • View
    29

  • Download
    0

Embed Size (px)

Citation preview

Page 1: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Continuous DocumentationDaniel Kocot (@dk_1977)

bed-con 2017

22.9.2017

1

Page 2: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

2

Page 3: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

3

Show your hands

Page 4: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

4

Continuous Delivery

Develop

Build

TestDeploy

Release

Page 5: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Agilität und Dokumentation

5

Page 6: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

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

6

Page 7: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Agiles Manifest

Funktionierende Software mehr als umfassende Dokumentation

7

Page 8: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Bedarfsgerechte Dokumentation

8

Page 9: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Orientierung am Leserkreis

9

Page 10: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

10

Dokumentation von relevantem Wissen

Page 11: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

11

Skalierbare Dokumentation

Page 12: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Lerneffekt durch Dokumentation

12

Page 13: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Dokumentationsplanung

13

Page 14: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Lebendige Anforderungen

14

Page 15: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Der Kunde im Kontext

15

Page 16: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Transparenz

16

Page 17: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Dokumentation als Inkrement

17

Page 18: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Verantwortlichkeit

18

Page 19: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Review

19

Page 20: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Der richtige Inhalt

20

Page 21: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Gestaltung

21

Page 22: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Umgang

22

Verteilung

DokumentationslandschaftAnleitung zur Erstellung

Wissensmanagement

Page 23: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Werkzeuge

23

Page 24: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Documentation as Code

24

Page 25: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Asciidoctor

25

Page 26: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

PlantUML

26

Page 27: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Automatisierung durch Buildpipeline

27

Page 28: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Multi-Channel Dokumentation

28

Page 29: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

Channels•Wikisysteme

•SSGs (Static Side Generators)

•PDFs

•Word-Dokumente (worst case!)

•Präsentationen

29

Page 30: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation

DEMO TIME

30

Page 31: continuous documentation bedconbed-con.org/2017/files/slides/Kocot-Continuous_Documentation.pdf · PlantUML 26. Automatisierung durch Buildpipeline 27. Multi-Channel Dokumentation