Seminar / Training Technische Dokumentation & Handbücher mit
Inhaltsverzeichnis
- Abstract
- Lernziele
- Zielgruppe
- Voraussetzungen
- Inhalte und Agenda
- Praxisanteile
- Ergebnisse und Transfer
Abstract
Dieses Seminar zeigt Typst als Plattform für technische Dokumentation, Spezifikationen und Handbücher. Im Fokus stehen modulare Inhalte, wiederverwendbare Komponenten, konsistente Strukturierung, Hinweis-/Warnsysteme, API- oder Parameterdokumentation sowie robuste Navigationshilfen wie Inhaltsverzeichnisse, Querverweise, Abbildungs- und Tabellenstandards. Zusätzlich werden Varianten (z. B. interne/öffentliche Version), Freigabeprozesse und produktive Build-Workflows behandelt. Ergebnis ist ein Handbuch-Prototyp mit Komponentenbibliothek und Doku-Standards.
Lernziele
- Informationsarchitektur für Handbücher modellieren
- Wiederverwendbare Doku-Komponenten etablieren
- Navigations- und Referenzsysteme robust umsetzen
- Varianten und Freigabeprozesse in die Doku integrieren
- Handbuch-Prototyp als Blaupause erstellen
Zielgruppe
Typst-Anwender und Teams, die technische Dokumentationen, Handbücher oder Spezifikationen produktiv erstellen möchten. Geeignet für Autoren, Technical Writers, DevOps-Teams und Entwickler, die modulare, wiederverwendbare Doku-Standards etablieren wollen.
Voraussetzungen
- Typst Grundlagen, Für Layoutintensität Layout & Styling mit Typst empfohlen, Für Automatisierung Automatisierung, CLI & Build-Workflows hilfreich
Inhalte und Agenda
- Informationsarchitektur und Doku-Standards
- Doku-Typen und Zielgruppen
- Kapitelstruktur und Wiederverwendung
- Styleguide für technische Texte
- Projektgerüst
- Komponenten für technische Inhalte
- Hinweis-/Warnsystem
- Parameter- und API-Blöcke
- Tabellenstandards
- Code-/Konfigurationsblöcke
- Navigation, Referenzen, Varianten
- Inhaltsverzeichnisse und Teilverzeichnisse
- Querverweise und Labelkonzept
- Abbildungs-/Tabellenlisten
- Variantensteuerung
- Build, Review, Betrieb
- Build-Blueprint
- Review-Workflow
- Freigabe und Versionierung
- Betriebskonventionen
Praxisanteile
- Informationsarchitektur und Doku-Standards
- Doku-Typen definieren: Quickstart, Referenz, Konzept, Tutorial, FAQ
- Einheitliche Kapitelstruktur entwerfen
- Styleguide festlegen: Terminologie, Schreibregeln, Einheiten, Warnhinweise
- Projektgerüst anlegen: Kapiteldateien, Assets, Komponenten, Styles
- Komponenten für technische Inhalte
- Hinweisboxen als Komponenten bauen: Note, Warning, Danger, Tip
- Parameter-/API-Komponenten definieren: Name, Typ, Default, Beschreibung, Beispiele
- Tabellenstandards definieren: Spaltenbreiten, Ausrichtung, Zebra-Option
- Code-/Konfigurationsblöcke standardisieren: Monospace, Zeilenumbruch, Labels
- Navigation, Referenzen, Varianten
- Inhaltsverzeichnisstruktur je Dokumentebene definieren
- Labelkonzept aufsetzen: Namensschema, Eindeutigkeit, Referenzregeln
- Abbildungs-/Tabellenlisten integrieren
- Varianten definieren: intern/extern, Editionen, Produktversionen
- Variantensteuerung als Parameter/Build-Matrix modellieren
- Build, Review, Betrieb
- Build-Blueprint ableiten: Targets, Artefakte, Naming
- Review-Workflow definieren: technische Reviewpunkte, Layoutreview, Freigabe
- Versionierungskonzept festlegen: Doku-Version vs. Produktversion
- Betriebskonventionen dokumentieren: Ordnerregeln, Komponentenpflege, Change-Regeln
Ergebnisse und Transfer
- Handbuch-Prototyp als Blaupause
- Komponentenbibliothek für wiederverwendbare Inhalte
- Robust implementiertes Navigations- und Referenzsystem
- Varianten- und Freigabeprozesse etabliert
- Build-Workflow für produktiven Einsatz dokumentiert
Seminar und Anbieter vergleichen
Öffentliche Schulung
Diese Seminarform ist auch als Präsenzseminar bekannt und bedeutet, dass Sie in unseren Räumlichkeiten von einem Trainer vor Ort geschult werden. Jeder Teilnehmer hat einen Arbeitsplatz mit virtueller Schulungsumgebung. Öffentliche Seminare werden in deutscher Sprache durchgeführt, die Unterlagen sind teilweise in Englisch.
Inhausschulung
Diese Seminarform bietet sich für Unternehmen an, welche gleiche mehrere Teilnehmer gleichzeitig schulen möchten. Der Trainer kommt zu Ihnen ins Haus und unterrichtet in Ihren Räumlichkeiten. Diese Seminare können in Deutsch - bei Firmenseminaren ist auch Englisch möglich gebucht werden.
Webinar
Diese Art der Schulung ist geeignet, wenn Sie die Präsenz eines Trainers nicht benötigen, nicht Reisen können und über das Internet an einer Schulung teilnehmen möchten.
Fachbereichsleiter / Leiter der Trainer / Ihre Ansprechpartner
-
Lucas Beich
Telefon: + 49 (221) 74740055
E-Mail: lucas.beich@seminar-experts.de
Seminardetails
| Dauer: | 2 Tage ca. 6 h/Tag, Beginn 1. Tag: 10:00 Uhr, weitere Tage 09:00 Uhr |
| Preis: |
Öffentlich und Webinar: CHF 1.198 zzgl. MwSt. Inhaus: CHF 3.400 zzgl. MwSt. |
| Teilnehmeranzahl: | min. 2 - max. 8 |
| Teilnehmer: | Typst-Anwender und Teams, die technische Dokumentationen, Handbücher oder Spezifikationen produktiv erstellen möchten. Geeignet für Autoren, Technical Writers, DevOps-Teams und Entwickler, die modulare, wiederverwendbare Doku-Standards etablieren wollen |
| Vorausetzung: | Typst Grundlagen, Für Layoutintensität Layout & Styling mit Typst empfohlen, Für Automatisierung Automatisierung, CLI & Build-Workflows hilfreich |
| Standorte: | Basel, Bern, Luzern, Sankt Gallen, Winterthur, Zürich |
| Methoden: | Vortrag, Demonstrationen, praktische Übungen am System |
| Seminararten: | Öffentlich, Webinar, Inhaus, Workshop - Alle Seminare mit Trainer vor Ort, Webinar nur wenn ausdrücklich gewünscht |
| Durchführungsgarantie: | ja, ab 2 Teilnehmern |
| Sprache: | Deutsch - bei Firmenseminaren ist auch Englisch möglich |
| Seminarunterlage: | Dokumentation auf Datenträger oder als Download |
| Teilnahmezertifikat: | ja, selbstverständlich |
| Verpflegung: | Kalt- / Warmgetränke, Mittagessen (wahlweise vegetarisch) |
| Support: | 3 Anrufe im Seminarpreis enthalten |
| Barrierefreier Zugang: | an den meisten Standorten verfügbar |
| Weitere Informationen unter +41 (800) 225127 |
Seminartermine
Die Ergebnissliste kann durch Anklicken der Überschrift neu sortiert werden.
