Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docToolchain @ 46a1aa4
gradle/wrapper
src/docs
.gitignore
.gitmodules
Config.groovy
README.adoc
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.adoc

hhgdac logo Docs-as-Code: (technische) Dokumentation in gut

Eine Folge von Artikeln für Informatik-Aktuell von R.D. Müller und G. Starke

Wir möchten Dokumentation in der Softwareentwicklung von vielerlei typischen Schmerzen befreien:

  • Wir generieren Dokumente, beispielsweise Architektur-, Schnittstellen- oder Betriebsdokumentation.

  • Wir arbeiten dabei DRY, modular und flexibel.

  • Wir erzeugen zielgruppenspezifische Ergebnisse, u.a. in HTML, pdf, docx oder Confluence.

Voraussetzungen

  • Gradle installiert zu haben, hilft ungemein…​ Wir bevorzugen die Installation über sdkman, den großartigen Package-Manager.

  • Eine Shell/Kommandozeile/Terminal.

Alternativ können Sie das Repository auch in gitpod.io öffnen, dann startet eine web basierte Entwicklungsumgebung:

open in gitpod

Einführung

Wir haben einen Wrapper für Gradle zugefügt - das macht den Einstieg für Sie noch einfacher. Da wir diesmal docToolchain verwenden, wird die HTML-Dokumentation mit

./gradlew generateHTML

und die PDF-Dokumentation mit

./gradlew generatePDF

erzeugt.

Falls Sie Gradle bereits installiert haben, geht’s auch so:

gradle generateHTML

Das Ergebnis, die Datei Part-2-DocToolchain.html, wird ins Verzeichnis ./build/asciidoc/html5 generiert, und entspricht dem Artikel aus der Informatik Aktuell.

Sie haben den Sparx Enterprise Architect auf Ihrem System installiert? Dann probieren Sie doch mal

./gradlew exportEA

aus. Hier spielt docToolchain sein volles Potential aus: EA wird headless gestartet und das Architektur-Diagramm aus dem Artikel neu exportiert. Ändern Sie das Diagramm und rufen

./gradlew exportEA generatePDF

aus. Und schon sind Ihre Änderungen im aktuellen PDF!

Sollten Sie den EA nicht auf Ihrem System haben, werden Sie die Entscheidung zu schätzen wissen, dass die exportierten Diagramme unter Versionkontrolle stehen und Sie dennoch die Dokumentation generieren können…​

Viel Spass beim Experimentieren!

Gernot & Ralf

You can’t perform that action at this time.