platzhalter für titelbild hier können sie bilder aus der ...blick in das template randbedingungen...

72
arc42, AsciiDoc, Gradle & Co. Im Einsatz DB Systel GmbH | Ralf D. Müller | JUG Saxony Day | 13.09.2019 Docs-as-Code

Upload: others

Post on 17-Feb-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 AsciiDoc Gradle amp Co Im Einsatz

DB Systel GmbH | Ralf D Muumlller | JUG Saxony Day | 13092019

Platzhalter fuumlr Titelbild ndash Hier koumlnnen Sie Bilder aus der Mediathek einfuumlgenPlaceholder for title picture ndash You can insert here pictures from the Mediathek

Docs-as-Code

Incomplete or confusing documentation1 Problem with Open Source

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920192

Ralf D Muumlller

Software Architect DB Systel mit Schwerpunkt

Web-Technologien

Qualitaumlt (Security Testautomation)

Produktivitaumlt (Gradle Groovy Grails)

Prozessoptimierung

In der Freizeit Geek arc42 Contributor ampMaintainer von docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920193

4 DB Systel GmbH | RalfDMueller | JUG Saxony Day | 13092019

Digital | bewegen | verstehen | anwenden | begleiten | vernetzen | denken und handeln

DB Systel Digital bewegen Gemeinsam

Dr Gernot Starke ndash innoQ Fellow

Softwarearchitektur

Entwurf

Evolution + Modernisierung

Dokumentation

Reviews

+49 177 7282570gernotstarkeinnoqcom

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920195

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 2: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Incomplete or confusing documentation1 Problem with Open Source

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920192

Ralf D Muumlller

Software Architect DB Systel mit Schwerpunkt

Web-Technologien

Qualitaumlt (Security Testautomation)

Produktivitaumlt (Gradle Groovy Grails)

Prozessoptimierung

In der Freizeit Geek arc42 Contributor ampMaintainer von docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920193

4 DB Systel GmbH | RalfDMueller | JUG Saxony Day | 13092019

Digital | bewegen | verstehen | anwenden | begleiten | vernetzen | denken und handeln

DB Systel Digital bewegen Gemeinsam

Dr Gernot Starke ndash innoQ Fellow

Softwarearchitektur

Entwurf

Evolution + Modernisierung

Dokumentation

Reviews

+49 177 7282570gernotstarkeinnoqcom

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920195

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 3: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Ralf D Muumlller

Software Architect DB Systel mit Schwerpunkt

Web-Technologien

Qualitaumlt (Security Testautomation)

Produktivitaumlt (Gradle Groovy Grails)

Prozessoptimierung

In der Freizeit Geek arc42 Contributor ampMaintainer von docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920193

4 DB Systel GmbH | RalfDMueller | JUG Saxony Day | 13092019

Digital | bewegen | verstehen | anwenden | begleiten | vernetzen | denken und handeln

DB Systel Digital bewegen Gemeinsam

Dr Gernot Starke ndash innoQ Fellow

Softwarearchitektur

Entwurf

Evolution + Modernisierung

Dokumentation

Reviews

+49 177 7282570gernotstarkeinnoqcom

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920195

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 4: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

4 DB Systel GmbH | RalfDMueller | JUG Saxony Day | 13092019

Digital | bewegen | verstehen | anwenden | begleiten | vernetzen | denken und handeln

DB Systel Digital bewegen Gemeinsam

Dr Gernot Starke ndash innoQ Fellow

Softwarearchitektur

Entwurf

Evolution + Modernisierung

Dokumentation

Reviews

+49 177 7282570gernotstarkeinnoqcom

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920195

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 5: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Dr Gernot Starke ndash innoQ Fellow

Softwarearchitektur

Entwurf

Evolution + Modernisierung

Dokumentation

Reviews

+49 177 7282570gernotstarkeinnoqcom

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920195

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 6: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Was machen wir die naumlchsten 60 Minuten

Mischung aus Tipps zu arc42 und docs-like-codeBest Practice zum Umgang zur Pflege einer

ArchitekturdokumentationExperimentelle Features -)Vorschlaumlge aus Erfahrung keine Silver Bullet

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920196

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 7: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

VEry NOrMal System

Gewachsene Dokumentation

Unterschiedliche Stakeholder

Aufgrund verschiedener Aumlnderungen stets im Wandel

Hoher Pflegeaufwand

Das VENOM Projekt

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920197

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 8: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Darf ich vorstellen Geoff ndash Solution Architect

Geoff ist Solution Architect bei SAMM Inc

Zustaumlndig fuumlr VENOM

Starker technischer Background

Aufgaben

Weiterentwicklung der Architektur

Pflege der Dokumentation

Kommunikation der Architektur

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920198

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 9: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 130920199

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 10: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Heutiger Fokus Architektur Docs-as-Code

Wie schreibe ich eine System-Dokumentation

Dr Peter Hruschkahttpwwwpeterhruschkaeu

Dr Gernot Starkehttpgernotstarkede

httparc42org

DAS Template fuumlr die Dokumentation eines Software Systems

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201910

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 11: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 hellip

hellip ist das Standard-Template im deutschsprachigen Raum

hellip ist verfuumlgbar in Deutsch Englisch und Spanisch und Russisch

hellip ist verfuumlgbar in gt 9 Formaten (adoc docx rst md tex hellip)

hellip gibt der Dokumentation eine einheitliche Struktur

hellip ist verfuumlgbar mit und ohne Hilfestellung

hellip hilft die richtigen Aspekte richtig zu dokumentieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201911

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 12: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201912

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 13: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 ndash ein Kleiderschrank fuumlr Dokumentation

1 Requirements amp Goals

2 Constraints

3 Scope amp Context

4 Solution Strategy

5 Building Block View

6 Runtime View

7 Deployment View

10 Quality Scenarios

11 Risks amp Tech Debt

12 Glossary

9 Decisions

8 Crosscutting Concepts

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201913

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 14: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Format der Dokumentation

MS Word ist der etablierte Standard

Arc42 existiert in vielen Formaten

Docx latex htmlAsciidoc textile confluencemarkdown

Geoff waumlhlt AsciiDoc aufgrund vieler Vorteile AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201914

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 15: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Blick in das Template

Randbedingungen

InhaltRandbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

MotivationFuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

FormEinfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie technische organisatorische und politische Randbedingungen oder uumlbergreifende Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201915

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 16: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 als AsciiDoc Template

== Randbedingungen

[role=arc42help]

Inhalt

Randbedingungen und Vorgaben die ihre Freiheiten bezuumlglich Entwurf Implementierung

oder Ihres Entwicklungsprozesses einschraumlnken Diese Randbedingungen gelten manchmal

organisations- oder firmenweit uumlber die Grenzen einzelner Systeme hinweg

Motivation

Fuumlr eine tragfaumlhige Architektur sollten Sie genau wissen wo Ihre Freiheitsgrade

bezuumlglich der Entwurfsentscheidungen liegen und wo Sie Randbedingungen beachten muumlssen

Sie koumlnnen Randbedingungen vielleicht noch verhandeln zunaumlchst sind sie aber da

Form

Einfache Tabellen der Randbedingungen mit Erlaumluterungen Bei Bedarf unterscheiden Sie

technische organisatorische und politische Randbedingungen oder uumlbergreifende

Konventionen (beispielsweise Programmier- oder Versionierungsrichtlinien

Dokumentations- oder Namenskonvention)

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201916

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 17: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

arc42 Formate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201917

AsciiDoc ist aus unserer Sicht das flexibelste Format

Da es in alle anderen Formate (fast verlustfrei) gewandelt werden kann gibt es immer bdquoPlan Bldquo

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 18: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Treat Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201918

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 19: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Was ist Docs-as-Code

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201919

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

------------------------------------------------

This ASCII pic can be found at

httpsasciiartwebsiteindexphpart=animalsdogs

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

--_______-

_`-

_` `` | ) `-

(` `-_ ` ______

o-`- o )` - `---))

d8b ^- | ` ` `

| ___ ` | ` `

| ( -`- `

| | `

-`_`__)

`- `-- |

` |

( ` |

`

`|-- ` - --

|`--______ |

| | |

|

_-- | -hrr- `-- ___|

| |___

`^_-- )

`-_-

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 20: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

demoadoc buildgradle console output

= A first Headline

And a first paragraphIt continous on the next headline

Second paragraph

== Second-Level Headline

A link to httpasciidoctororgdocs[Asciidoctororg]

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201920

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 21: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

demoadoc buildgradle console output

plugins id orgasciidoctorconvert version 153

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201921

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 22: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

buildgradle demoadoc console output

PS CUsersDemojax2017demo1gt gradle asciidocasciidoctorioconsole not supported tty will not be manipulated

BUILD SUCCESSFUL

Total time 4554 secsPS CUsersDemojax2017demo1gt

Demo ndash eine erste Konvertierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201922

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 23: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

buildgradle demoadoc console output

Demo ndash eine erste Konvertierung

httpasciidoctororgdocsrender-documents

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201923

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 24: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Out-of-the-Box Features

bdquoablenkungsfreildquo ndash Dokumentation wie eMails schreiben

Gliederung in Unterdokumente

Neugliederung je nach Stakeholder

Bilder werden referenziert nicht eingebettet

leichte Versionierung bdquohandle Docs-as-Codeldquo

Formatierung von Source-Code

Reviews Pull-Requests Versionierung durch Git

Konvertierung nach HTML5 und DocBook

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201924

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 25: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

adocadoc

hellipdoch die Reise beginnt erst

docx adoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201925

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 26: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code I Version Control

adocadocadoc html

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201926

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 27: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code II Git-Flow

adocadocadoc html

Fork

PR

adoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201927

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 28: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code III Build-Server

adocadocadoc html

Fork

PR

adoc

Build-Server

On Change

Publish

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201928

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 29: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

The End

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201929

Danke fuumlr Ihre Aufmerksamkeit

Fragen

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 30: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Diagramme

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201930

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 31: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Diagramme

httpplantumlcom

httpasciidoctororgdocsasciidoctor-diagram

Komplexe Diagramme als einfachen Text verwalten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201931

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 32: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201932

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 33: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201933

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 34: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Diagramme PlantUML

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201934

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 35: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201935

PNG-Diagramm

ltxmlgthellip

ltxmlgtMeta-Daten

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 36: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

drawio

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201936

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 37: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Diagramme Nicht malen modellieren

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201937

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 38: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code IV automate

Betreiber und Administratoren von VENOM

Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201938

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 39: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code IV automate

adocstakeholder| Operations| Betreiber und Administratoren von VENOM| Flexibilitaumlt hinsichtlich Betriebsumgebung Betriebssystem Moumlglichst wenig Aufwand bei technischer Administration und Inbetriebnahmen Technisches Monitoring

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201939

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 40: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

=== Stakeholder

==== Users and Groups of Users

[[figure-users]]imageea15_Stakeholderpng[title=Users and Groups of Users]

[cols=2332 options=header]Users and Groups of Users|===| Role | Description | Goal | Comment

includeeastakeholderad[]

|===

treat Docs-as-Code automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201940

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 41: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

treat Docs-as-Code IV automate

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201941

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 42: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Stakeholder

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201943

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 43: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

docx bzw MS Word

httppandocorg

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201944

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 44: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

docx bzw MS Word

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201945

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 45: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

bzw pdf

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201946

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 46: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Modulare Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201947

arc42-masteradoc

kapitel1adoc

kapitel2adocpublic class HelloWorld

public static void main (String[] args)

Ausgabe Hello World

Systemoutprintln(Hello World)

include

include

include

kapitel8adoc

kapitel81adoc

include

security-masteradoc

business-masteradoc

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 47: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201948

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 48: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201949

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 49: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201950

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 50: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201951

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 51: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201952

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 52: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201953

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 53: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201954

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 54: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Besser statische Seiten

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201955

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 55: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201956

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 56: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Besser statische Seiten -

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201957

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 57: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Zusammenarbeit - Tabellen

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201958

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 58: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Tabellen in AsciiDoc

[options=headercols=72317331111]

|===

| Nr

| Name

| Rolle

| Email

| Telefon

| PLZ

| 1

| Hubert Kleinschmidt

| Product Owner

| hkleinschmidtexamplecom

| 555 102

| 40388

| 2

| Erika Mustermann

| Scrum Master

| emustermannexamplecom

| 555 103

| 41222

|===

mit MS Excel

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201959

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 59: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Managing Tables in AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201960

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 60: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Testing

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201961

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 61: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201962

Broken Cross References (aka Broken Internal Links)

Missing Images Files

Multiple Definitions of Bookmarks or IDrsquos

Missing Local Resources

Missing Alt-tags in Images

httpsgithubcomaim42htmlSanityCheck

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 62: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Automatisiertes Testing der Doku

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201963

httpsgithubcomaim42htmlSanityCheck

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 63: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

hellip demnaumlchst Linting

httpwwwhemingwayappcom

httpsgithubcombtfordwrite-good

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201964

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 64: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Static Site Generators

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201965

arc42Dokumentation

Test-ReportsLanding-Page Blog

User-Manual

Suche

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 65: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Static Site Generators mit AsciiDoc

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201966

Quelle wwwstaticgencom

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 66: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Landing-Page

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201967

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 67: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Umfangreiche AsciiDoc-Dokumentation

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201968

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 68: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201969

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 69: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

News Blog mit RSS-Feed

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201970

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 70: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

docToolchain

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201971

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 71: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

DB Systel GmbH | RalfDMueller | JUG Saxony Day | 1309201972

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback

Page 72: Platzhalter für Titelbild Hier können Sie Bilder aus der ...Blick in das Template Randbedingungen Inhalt Randbedingungen und Vorgaben, die ihre Freiheiten bezüglich Entwurf, Implementierung

Vielen Dank fuumlr Ihre Aufmerksamkeit

RalfDMuellerDeutscheBahncom

httpsdocs-as-code

docToolchain

Image-Credits Title - Photo by Susan Yin on Unsplash Clipart presentermediacom licenced to ralfdmuellergmailcom

wwwdbsystelde

httpsrdmuellergithubiofeedback