Bitte wählen Sie die Bereiche, die Sie exportieren möchten:
Schulung Docs-as-Code: Technische Dokumentation mit Git, Markdown und CI/CD
Automatisierte Publishing-Pipelines: Static Site Generators und CI/CD im Einsatz
Schulungsformen
Offene Schulung
- 2 Tage
- 5 gesicherte Termine
- Köln / Online
- 1.440,00 p. P. zzgl. MwSt.
- Dritter Mitarbeitende kostenfrei
- Learning & Networking in einem. Garantierte Durchführung ab 1 Teilnehmenden.
Inhouse-/Firmenschulung
- 2 Tage - anpassbar
- Termin nach Wunsch
- In Ihrem Hause oder bei der GFU
- Preis nach Angebot
- Lernumgebung in der Cloud
- Inhalte werden auf Wunsch an die Anforderungen Ihres Teams angepasst.
Individualschulung
- 2 Tage - anpassbar
- Termin nach Wunsch
- In Ihrem Hause oder bei der GFU
- Preis nach Angebot
- Lernumgebung in der Cloud
- 1 Teilnehmender = Fokus aufs Fachliche und maximaler Raum für individuelle Fragen.
Beschreibung
Unternehmen profitieren von drastisch reduzierten Bearbeitungszeiten, einer höheren Konsistenz zwischen Code und Doku sowie einer gesteigerten Entwicklerzufriedenheit durch den Einsatz gewohnter Tools und Workflows.
Erfahren Sie mehr durch eine zusätzliche Git Schulung aus unserem Seminarangebot.
Schulungsziel
Die Teilnehmenden erlernen die praktischen Abläufe des Docs-as-Code-Ansatzes. Ziel ist es, Dokumentationen in Markdown oder AsciiDoc zu verfassen, Git für das Versionsmanagement und Code-Reviews zu nutzen sowie mittels MkDocs oder Docusaurus automatisierte Dokumentationsportale zu generieren, die nahtlos in bestehende Entwicklungsumgebungen integriert sind.
Details
Inhalt
- Ziele und Erwartungen der Teilnehmenden
- Klärung individueller Lernziele und Erwartungen für ein praxisnahes und relevantes Seminar
- 1. Philosophie: Was ist Docs-as-Code?
- Kernprinzipien: Trennung von Inhalt und Design, Nutzung von Standard-Dev-Tools.
- Vorteile: Versionierung, Zusammenarbeit in Echtzeit und Vermeidung von Redundanz.
- Kulturwandel: Dokumentation als integraler Bestandteil des Software-Life-Cycles.
- 2. Lightweight Markup: Markdown und AsciiDoc
- Markdown: Schneller Einstieg, CommonMark und GFM (GitHub Flavored Markdown).
- AsciiDoc: Die mächtige Alternative für komplexe Dokumente (Includes, Variablen, Attribute).
- Strukturierung: Semantisches Schreiben und Cross-Referencing.
- 3. Versionskontrolle mit Git für Dokumentation
- Branching-Modelle: Dokumentations-Updates parallel zu Software-Features.
- Commit-Hygiene: Aussagekräftige Änderungshistorien für technische Inhalte.
- Kollaboration: Nutzung von Pull Requests für Fach-Reviews und Korrekturläufe.
- 4. Static Site Generators (SSG) im Vergleich
- Docusaurus: Ideal für React-basierte, moderne Landingpages und Docs.
- MkDocs (Material Theme): Der Standard für Python-Projekte und schnelle Setups.
- Sphinx: Die erste Wahl für API-Dokumentation und technische Handbücher.
- 5. Automatisierung: CI/CD für Dokumentation
- Build-Prozesse: Automatisches Generieren der HTML-Seite bei jedem Push.
- Testing: Automatisierte Prüfung auf tote Links, Rechtschreibung und Formatierung (Linting).
- Deployment: Veröffentlichung auf Webservern, GitHub Pages oder S3-Buckets.
- 6. Dokumentationsstruktur und Wiederverwendbarkeit
- Modularisierung: Textbausteine (Snippets) und Includes effizient nutzen.
- Versionierung: Verwaltung unterschiedlicher Releasestände einer Dokumentation.
- Internationalisierung (i18n): Workflows für mehrsprachige Dokumentationen.
- 7. API-Dokumentation integrieren
- OpenAPI/Swagger: Automatische Einbindung von API-Referenzen in die Docs.
- Code-to-Doc: Generierung von Dokumentation direkt aus dem Quellcode (Docstrings).
- Interaktive Beispiele: Einbetten von Live-Code-Editoren und API-Explorern.
- 8. UX und Design für technische Dokumentation
- Searchability: Implementierung von Volltextsuchen (Algolia, Lunr).
- Navigation: Optimierung von Seitenstrukturen und Inhaltsverzeichnissen.
- Readability: Typografie, Dark Mode und responsive Darstellung auf mobilen Geräten.
- 9. Praxis-Simulation: Das „Doc-Pipeline“ Projekt
- Workshop: Aufbau eines Dokumentations-Repos von Null.
- Challenge: Implementierung eines CI/CD-Workflows mit automatischem Link-Checker.
- Review-Training: Durchführung eines Peer-Reviews via Git-Plattform.
- Final Audit: Veröffentlichung der fertigen Seite und Prüfung der Barrierefreiheit.
Zielgruppe & Vorkenntnisse
- Technische Redakteure: Die moderne, entwicklerrelevante Toolchains nutzen möchten.
- Softwareentwickler & Architekten: Zur Verbesserung der internen und externen Dokumentation.
- DevOps Engineers: Zur Automatisierung von Dokumentations-Deployments.
- Produktmanager: Zur Etablierung effizienter Review- und Freigabeprozesse.
Ihre Schulung
In Präsenz | Online |
|---|---|
| Lernmethode | |
Ausgewogene Mischung aus Theorie und Praxis | Wie auch bei unseren Präsenz-Seminaren: Ausgewogene Mischung aus Theorie und praktischen Übungen. Trainer durchgehend präsent. |
| Unterlagen | |
Seminarunterlagen oder Fachbuch zum Seminar inklusive, das man nach Rücksprache mit dem Trainer individuell auswählen kann. | Seminarunterlagen oder Fachbuch inklusive (via DHL). Das Fachbuch wählt der Trainer passend zum Seminar aus - Ihren individuellen Buch-Wunsch berücksichtigen wir auf Nachfrage gerne. |
| Arbeitsplatz | |
| PC/VMs für jeden Teilnehmenden Hochwertige und performante Hardware Große, höhenverstellbare Bildschirme Zugang zu Ihrem Firmennetz erlaubt |
|
| Lernumgebung | |
Neu aufgesetzte Systeme für jeden Kurs in Abstimmung mit dem Seminarleiter. | |
| Arbeitsmaterialien | |
DIN A4 Block, Notizblock, Kugelschreiber, USB-Stick, Textmarker, Post-its | |
| Teilnahmezertifikat | |
Nach Abschluss des Seminars erhalten Sie das Teilnahmezertifikat inkl. Inhaltsverzeichnis per E-Mail als PDF. | |
Organisation
In Präsenz | Online | |
|---|---|---|
| Teilnehmendenzahl | ||
min. 1, max. 8 Personen | ||
| Garantierte Durchführung | ||
Ab 1 Teilnehmenden* | ||
| Schulungszeiten | ||
| ||
| Ort der Schulung | ||
 GFU SchulungszentrumAm Grauen Stein 27 51105 Köln-Deutz oder online im Virtual Classroom oder europaweit bei Ihnen als Inhouse-Schulung Um ein optimales Raumklima zu gewährleisten, haben wir das Schulungszentrum mit 17 hochmodernen Trotec TAC V+ Luftreinigern ausgestattet. Diese innovative Filtertechnologie (H14 zertifiziert nach DIN EN1822) sorgt dafür, dass die Raumluft mehrfach pro Stunde umgewälzt wird und Schadstoffe zu 99.995% im HEPA-Filter abgeschieden und infektiöse Aerosole abgetötet werden. Zusätzlich sind alle Räume mit CO2-Ampeln ausgestattet, um jederzeit eine hervorragende Luftqualität sicherzustellen. | ||
| Räumlichkeiten | ||
Helle und modern ausgestattete Räume mit perfekter Infrastruktur | Bequem aus dem Homeoffice von überall | |
| Preisvorteil | ||
Dritter Mitarbeitende nimmt kostenfrei teil. Eventuell anfallende Prüfungskosten für den dritten Teilnehmenden werden zusätzlich berechnet. Hinweis: Um den Erfolg der Schulung zu gewährleisten, sollte auch der dritte Teilnehmende die erwarteten Vorkenntnisse mitbringen. | ||
| All-Inclusive | ||
Gebäck, Snacks und Getränke ganztägig, Mittagessen im eigenen Restaurant, täglich 6 Menüs, auch vegetarisch | Eine Auswahl unserer Frühstücks-Snacks und Nervennahrungs-Highlights senden wir Ihnen mit den Seminarunterlagen via DHL zu. | |
| Barrierefreiheit | ||
Das GFU-Schulungszentrum (Am Grauen Stein 27) ist barrierefrei | - | |
Buchen ohne Risiko
| Rechnungsstellung |
Erst nach dem erfolgreichen Seminar. Keine Vorkasse. |
| Stornierung |
Kostenfrei bis zum Vortag des Seminars |
| Vormerken statt buchen |
Sichern Sie sich unverbindlich Ihren Seminarplatz schon vor der Buchung - auch wenn Sie selbst nicht berechtigt sind zu buchen |
Kostenfreie Services
In Präsenz | Online |
|---|---|
|
|
Buchungsmöglichkeiten
Online oder in Präsenz teilnehmen
Sie können sowohl Online als auch in Präsenz am Seminar teilnehmen. Klicken Sie bei Ihrer Buchung oder Anfrage einfach die entsprechende Option an.
Gesicherte offene Termine
| Termin | Ort | Preis | ||
|---|---|---|---|---|
| 31.08.-01.09.2026 Plätze vorhanden Köln / Online 1.440,00 | Köln / Online | 1.440,00 | Buchen Vormerken | |
| 02.11.-03.11.2026 Plätze vorhanden Köln / Online 1.440,00 | Köln / Online | 1.440,00 | Buchen Vormerken | |
| 2027 | ||||
| 15.02.-16.02.2027 Plätze vorhanden Köln / Online 1.440,00 | Köln / Online | 1.440,00 | Buchen Vormerken | |
| 15.04.-16.04.2027 Plätze vorhanden Köln / Online 1.440,00 | Köln / Online | 1.440,00 | Buchen Vormerken | |
| 15.06.-16.06.2027 Plätze vorhanden Köln / Online 1.440,00 | Köln / Online | 1.440,00 | Buchen Vormerken | |
- Lernumgebung in der Cloud
- Inhalte werden auf Wunsch an die Anforderungen Ihres Teams angepasst.
- Lernumgebung in der Cloud
- 1 Teilnehmender = Fokus aufs Fachliche und maximaler Raum für individuelle Fragen.
Unterstützung nach der Schulung durch
individuelle Nachbetreuung
- Alle folgenden Schulungsformen können auch Online als Virtual Classroom durchgeführt werden.
- Eine Offene Schulung findet zu einem festgelegten Zeitpunkt im voll ausgestatteten Schulungszentrum oder Online/Remote statt. Sie treffen auf Teilnehmende anderer Unternehmen und profitieren vom direkten Wissensaustausch.
- Eine Inhouse-/Firmen-Schulung geht auf die individuellen Bedürfnisse Ihres Unternehmens ein. Sie erhalten eine kostenfreie Beratung von Ihrem Seminarleiter und können Inhalte und Dauer auf Ihren Schulungsbedarf anpassen. Inhouse-Schulungen können Europaweit durchgeführt werden.
- Bei einer Individual-Schulung erhalten Sie eine 1-zu-1 Betreuung und bestimmen Inhalt, Zeit und Lerntempo. Der Dozent passt sich Ihren Wünschen und Bedürfnissen an.
Sie können unsere Schulungen auch als Remote Schulung im Virtual Classroom anfragen.
In drei Schritten zum Online Seminar im Virtual Classroom:
- Seminar auswählen und auf "Buchen" klicken
- Wählen Sie bei "Wie möchten Sie teilnehmen?" einfach "Online" aus.
- Formular ausfüllen und über den Button "Jetzt buchen" absenden.
Unser Kundenservice meldet sich bei Ihnen mit der Buchungsbestätigung.
Unsere Online Schulungen finden im Virtual Classroom statt. Ein Virtual Classroom bündelt mehrere Werkzeuge, wie Audio-Konferenz, Text-Chat, Interaktives Whiteboard, oder Application Sharing.
Vorteile von Virtual Classroom:
- Sie erhalten 1 zu 1 die gleiche Lernumgebung, die Sie auch vor Ort bei uns vorfinden
- Die technische Vorbereitung wird von den GFU-Technikern vorgenommen
- Sie erhalten remote Zugriff auf Ihren persönlichen Schulungs-PC im GFU-Seminarraum
- Die Virtual Classroom Lösung lässt sich auch im Browser betreiben
- Die GFU-Technik leistet wie gewohnt Soforthilfe bei Problemen
- Die Schulungsunterlagen bekommen Sie via DHL zugeschickt
- Sie sparen Reisekosten und Zeit
- 31. Aug. - 01. Sep. ✓ Noch einige Plätze frei ▶ Köln + Online/Remote
- 02. Nov. - 03. Nov. ✓ Noch einige Plätze frei ▶ Köln + Online/Remote
- 15. Feb. - 16. Feb. ✓ Noch einige Plätze frei ▶ Köln + Online/Remote
- 15. Apr. - 16. Apr. ✓ Noch einige Plätze frei ▶ Köln + Online/Remote
- 15. Jun. - 16. Jun. ✓ Noch einige Plätze frei ▶ Köln + Online/Remote
- Auch als Inhouse-Schulung, bundesweit mit Termin nach Wunsch und individuellen Inhalten
- Buchen ohne Risiko! Kostenfreie Stornierung bis zum Vortag des Seminars
Die Seminare der GFU finden in angenehmer Atmosphäre statt und sind perfekt organisiert. Profitieren Sie von dem Rundum-Service der GFU!
Machen Sie sich keinen Kopf um die Anreise! Unser Shuttle fährt Sie. Oder Sie parken einfach auf einem extra für Sie reservierten Parkplatz.
Hotelzimmer gesucht? Wir organisieren Ihnen eins. Ihr Vorteil: Sie sparen Zeit und Geld!
Stornierung bei offenen Seminaren kostenfrei bis einen Tag vor Schulungsbeginn.
Unsere Techniker sind immer zur Stelle, egal ob online oder vor Ort.