1 Muster M1 · M8
Verstärkung im Redaktionsteam
Für Teams, die bereits in DITA arbeiten und für eine Auslieferung, eine Normänderung oder eine offene Stelle eine erfahrene Person brauchen.
Vorgehen
Ich komme für die Dauer des Projekts in Ihr Redaktionsteam und arbeite mit jedem XML-Werkzeug in Ihrer Umgebung: Editor, Redaktionssystem und Publikationskette, so wie sie bei Ihnen eingerichtet sind. Ich schreibe und überarbeite Topics vom Typ Concept, Task und Reference, pflege Maps und setze Wiederverwendung über conref und Keys sowie Varianten über Bedingungsattribute nach Ihrem Leitfaden um.
Einarbeiten muss ich mich in Ihr Produkt und Ihre Regeln, nicht in DITA. Das spart die Wochen, die eine neue Kraft ohne DITA-Erfahrung bräuchte.
Ergebnis
- freigabefertige Topics und Maps in Ihrem System
- eine Liste dessen, was mir an Struktur und Wiederverwendung auffällt; was davon umgesetzt wird, entscheiden Sie
- zum Schluss ein kurzer Übergabestand: was fertig ist, was offen ist und wo was liegt
Grenze
Ihre Regeln gelten. Ihren Leitfaden stelle ich nicht in Frage, solange Sie mich nicht danach fragen.
Einstieg: ein kurzes Gespräch über Produkt, Werkzeuge und Termin. Danach kann ich in der Regel ohne lange Einarbeitung beginnen.
2 Muster M7
Umstieg nach DITA
Für Redaktionen, die aus Word, FrameMaker oder einem anderen Redaktionssystem nach DITA wechseln.
Vorgehen
Ein Umzug ist die beste Gelegenheit, Struktur zu schaffen, und die teuerste, wenn alte Kapitel nur in neue Dateien kopiert werden. Ich nehme den Bestand auf, zerlege bestehende Kapitel in Topics, lege Topic-Typen, Metadaten, Terminologie und die Regeln für Wiederverwendung und Varianten fest und migriere eine Anleitung als Probe. Danach migriert Ihr Team den Rest, oder ich mache es zusammen mit Ihrem Team.
Ergebnis
- ein Content-Modell mit Topic-Typen, Metadaten und Regeln für die Wiederverwendung
- Migrationsregeln und eine migrierte Probeanleitung als Vorlage
- eine Liste der Inhalte, die zusammengeführt, gestrichen oder neu geschrieben werden sollten
Die Struktur dahinter beschreibt Angebot C: Struktur, bevor sie teuer wird.
Grenze
Ein Redaktionssystem wähle ich nicht aus und führe keines ein. Konvertierungsskripte, XSLT und Plugins für das DITA Open Toolkit programmiere ich nicht; die technische Umsetzung bleibt bei Ihrer IT oder dem Systemanbieter.
Einstieg: die Probemigration einer Anleitung. Danach sehen Sie, wie Ihre Inhalte in DITA aussehen und wie viel Arbeit der Rest macht.
3 Muster M6 · M7
Struktur-Check für Ihren DITA-Bestand
Für Teams, die schon länger in DITA arbeiten und merken, dass Wiederverwendung und Varianten unübersichtlich geworden sind.
Vorgehen
Ich sehe mir Ihre Maps, Topic-Typen, conrefs, Keys, Bedingungen und Metadaten an und spreche mit den Menschen, die täglich damit arbeiten. Typische Befunde sind verkettete Wiederverwendung, die niemand mehr nachvollziehen kann, doppelt gepflegte Topics, Tasks, die eigentlich Concepts sind, und Bedingungen, die in keiner Ausgabe mehr wirken.
Soll ein KI-Assistent aus Ihren Inhalten antworten, prüfe ich auch, ob Topics und Metadaten dafür tragen. Das ist konzeptionelle Arbeit; die technische Anbindung des Assistenten gehört nicht dazu.
Ergebnis
- ein schriftlicher Befund mit Beispielen aus Ihrem eigenen Bestand
- Maßnahmen, sortiert nach Wirkung und Aufwand, für das System, das Sie schon haben
Grenze
Ich ersetze Ihr Werkzeug nicht und entwickle keine Spezialisierungen und keine eigenen DTDs.
Einstieg: der Struktur-Check an einer Map, fester Zeitraum, Abrechnung nach Stunden.
4 Muster M4 · M6
Sicherheitshinweise und Nachweise in DITA
Für Hersteller in regulierten Branchen, deren Warnhinweise aus der Risikobeurteilung kommen und das belegen müssen.
Vorgehen
In DITA lassen sich Sicherheitshinweise als eigene, wiederverwendbare Elemente führen. Ich baue sie nach IEC/IEEE 82079-1 auf, verbinde jeden Hinweis mit der Gefährdung aus der Risikobeurteilung und lege über Metadaten fest, wo er in welcher Variante erscheinen muss. So bleibt nachvollziehbar, warum ein Hinweis da steht, und eine Änderung der Risikobeurteilung erreicht jede Ausgabe.
Ergebnis
- wiederverwendbare Sicherheitshinweise mit einheitlicher Struktur und Terminologie
- eine Zuordnung von Gefährdung zu Sicherheitshinweis und seiner Stelle in der Benutzerinformation
Den Abgleich von Risikobeurteilung und Anleitung beschreibt Angebot B: Eine Anlage, eine Wahrheit.
Grenze
Ihre Sicherheitsingenieure entscheiden, was sicher ist, und die Risikobeurteilung bleibt bei den Fachleuten des Herstellers. Ein Sicherheitshinweis ersetzt keine Schutzmaßnahme; die Verantwortung für die Konformität bleibt beim Hersteller und den zuständigen Stellen.
Einstieg: der Abgleich der Sicherheitshinweise einer Anleitung mit ihrer Risikobeurteilung.