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
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 inklusive. Das Fachbuch wählt der Trainer passend zum Seminar aus - Ihren individuellen Buch-Wunsch berücksichtigen wir auf Nachfrage gerne. | 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 | |
|
|
| Lernumgebung | |
Neu aufgesetzte Remote-Systeme für jeden Kurs in Abstimmung mit dem Seminarleiter, sodass Sie über ein perfektes Setup für die Durchführung aller praktischen Übungen verfügen. | |
| 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 | |
| All-Inclusive | ||
Frühstü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 | - | |
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.
- 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.
Was bedeutet Offene Schulung und Inhouse Schulung?
Bei einer offenen Schulung stehen Ort und Termin vorab fest. Jeder Interessent kann eine offene Schulung buchen, daher treffen Teilnehmer aus verschiedenen Unternehmen aufeinander.
Inhouse Schulungen können auf Ihren individuellen Schulungsbedarf zugeschnitten werden. Sie bestimmen den Teilnehmerkreis, Termin und Schulungsort.
Ist eine Inhouse Schulung die richtige Wahl?
Bei einer Inhouse Schulung gehen wir auf die individuellen Bedürfnisse Ihres Unternehmens ein und decken den Schulungsbedarf direkt bei Ihnen im Unternehmen ab.
Das spart Zeit und Geld und sorgt für einen schnellen Wissenstransfer Ihrer Mitarbeiter.
Wer kümmert sich um die Technik bei Inhouse Schulungen?
Eine komplette Lernumgebung in der Cloud mit Remote Zugriff ist für uns selbstverständlich. Sie müssen sich um nichts kümmern. Lediglich ein funktionierender PC oder Notebook mit Internetanschluss sollte für jeden Teilnehmer am Schulungstag bereit stehen.
Vorteile einer Inhouse Schulung
- Kompetente Seminarberatung
- Dozenten aus der Praxis
- Auf Ihre Bedürfnisse zugeschnittener individueller Lernstoff
- Sie können den Termin flexibel gestalten, so wie es für Sie am besten passt
- Unsere Inhouse Schulungen können Europaweit durchgeführt werden
- Der Fokus liegt auf Ihrem Schulungsbedarf, somit schonen Sie Ihr Budget
- Wissenslücken Ihrer Mitarbeitet werden schnell geschlossen