Blog

Check if oder check that? Oder: Have you tried turning it off and on again?

Wie oft schreiben oder lesen wir in Anleitungen, dass wir etwas prüfen sollen. Beispiel: "Check if the computer is connected to power." Klare Ansage, alles schön. Was aber, wenn dort steht: "Check that the computer is connected to power"? mehr ...

Hoher Qualitätsanspruch ohne mentale Sandburgen und Dünkel - 10 Fragen an Ines Lasch

Ines Lasch macht eine Weiterbildung zur Technischen Redakteurin und absolviert ein achtwöchiges Praktikum bei parson. Wir haben ihr zehn Fragen gestellt. mehr ...

Volontariat für Technische Redakteure. Zwei Sichten auf die berufsbegleitende Ausbildung

Anja Schiel, Volontärin, und Ulrike Parson, Vorstand der parson AG, berichten über ihre Sicht des Volontariats für die Technische Redaktion.* mehr ...

Machen Sie Ihre technische Dokumentation intelligent – der Weg vom Content Management zu Content Delivery

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen. mehr ...

So funktioniert Mentoring bei parson

Die Bewerbung ist verschickt, das Vorstellungsgespräch war erfolgreich, jetzt kommt die Zusage. Und da ist er schon, der erste Arbeitstag, an dem alles so fremd ist: Kollegen, deren Namen man sofort wieder vergisst, Ablagestrukturen, Prozesse, ERP-System. Nicht mal die Kaffeemaschine funktioniert auf Anhieb. Und wo war noch mal der Besprechungsraum? mehr ...

Doku für die Suchmaschine, klare Review-Prozesse und krönenende Metadaten. Bericht von der tekom-Tagung 2016

Zwei spannende und vollgepackte Tage auf der tekom-Jahrestagung 2016 liegen hinter mir. Das Programm war so interessant, dass ich mich manchmal nicht entscheiden konnte, zu welchem Vortrag ich gehen sollte. Hier ein Bericht über vier Präsentationen.

MOB01. Michael Müller-Hildebrandt: Topic-orientierte Dokumentation – eine Herausforderung für den Redaktionsprozess

Vorab: Wir verwenden MMH als internes Kürzel für den Namen des Kollegen, um allzu lange Texte zu vermeiden.

Zunächst sprach MMH über das Buzzword-Bingo. DITA, iiRDS, Industrie 4.0, Information 4.0, Arbeit 4.0 – die Liste ist lang. (MMH wartet drauf, dass sich die ersten Firmen das 4.0 an ihre Namen hängen.) Groß waren meine Erwartungen an den Vortrag. So viel Neues erfuhr ich anfangs nicht. Ja, die Technische Doku befindet sich im Zeitalter von Industrie 4.0 an der Schnittstelle zum Anwender. Ja, das Time-to-market verkürzt sich. Ja, Produkte werden immer individueller und damit auch die Doku.

tekom tagung 2016Tekom-Jahrestagung 2016 in Stuttgart. Foto: Uta Lange

Dann wurde es interessant. Die Software-Anteile bei Produkten nehmen weiter zu. Nicht nur verändern sie die Produkte, sie machen sie mitunter zu neuen. MMH nannte als Beispiel die Over-the-air-Updates für die Tesla-Autos. Wo bleibt in diesem Prozess die Doku? Hat sie überhaupt eine Chance, aktuell zu bleiben?

Wenn wir alle zwei Wochen eine neue Version einer Software herausgeben, brauchen wir bessere und schnellere Freigabeprozesse für die Dokumentation. Der Topic-orientierte Ansatz funktioniert nur, wenn die Redakteure engen Kontakt zur Entwicklung haben. Nur wenn sie frühzeitig über Änderungen in der Entwicklung informiert werden, können sie reagieren und die Doku aktualisieren. Dann passen auch die Topics zu den verschiedenen Produktvarianten und -versionen.

Darüber hinaus müssen Topics genau klassifiziert werden. Jedes Topic benötigt eine eindeutige Adresse, damit wir es wiederfinden können. MMH nannte hier die PI-Klassifizierung von Prof. Ziegler. Diese Klassifizierung gibt uns jedoch nur die Richtung vor, sie ist eine Methode, keine fertige Lösung. Die konkrete Klassifizierung mit „unseren“ Metadaten müssen wir letztendlich selbst machen. MMH hatte wieder ein anschauliches Beispiel parat: Biegen Sie zweimal rechts ab, fahren 100 m geradeaus und nehmen Sie danach die nächste links. Mit Straßensperrungen und Umleitungen müssen wir selber zurechtkommen.

Das Fazit: Konsistente Informationen sind die Voraussetzung für die Topic-orientierte Dokumentation. Ein Topic-orientierter Redaktionsprozess ist die Lösung für die zukünftigen Anforderungen an die Dokumentation.

tekom tagung 2016 WarnhinweiseAuch Warnhinweise müssen mal Mittag essen. Foto: Uta Lange

PTK02. Hallmann, Wiswedel: Klare Prozesse – bessere Doku

Ich dachte, ich hätte mich verhört, aber nein: für die 3000 Mitarbeiter bei der TUI Fly gibt es 5 (five, fimm, fünf!) technische Redakteure, die die Dokumentation mit einem XML-basierten Redaktionssystem erstellen. Verschiedene Fachexperten (Piloten, Ingenieure, Service-Techniker) tragen dazu bei. In der Vergangenheit brachten sie ihre Änderungswünsche (CRs) auf allen möglichen Wegen ein: als Kommentare im PDF, per E-Mail oder Telefon, mitunter auch auf einem Post-It. Für die Redakteure wurde es aufgrund dieses unstrukturierten Prozesses immer schwieriger, die Doku revisionssicher zu erstellen. Denn jeder Änderungswunsch muss genehmigt und jede Einarbeitung nachvollziehbar dokumentiert werden. Hinzu kommen strenge Vorgaben durch die Behörden.

Die Revisionsplattform, die die OVIDUS GmbH für die TUI Fly implementierte und auf der tekom-Tagung vorstellte, ist webbasiert, von allen Standorten zugänglich und wird zentral verwaltet. Sie bietet die Einrichtung verschiedener Nutzergruppen mit unterschiedlichen Rechten, einen transparenten Workflow und Freigabeprozess und vor allem Revisionssicherheit. Änderungen können nachverfolgt, kommentiert und genehmigt werden. Nachdem eine Änderung freigegeben wurde, wird der CR geschlossen und der Redakteur arbeitet ihn in die Doku ein. Eine spannende und innovative Präsentation!

DPC04. Dr. Markus Nickl: SEO – Dokumentation für die Suchmaschine

tekom tagung 2016 programmausschnittWas hat Technische Redaktion mit Suchmaschinen-Optimierung zu tun? Das fragte ich mich auch und war neugierig auf den Vortrag von Dr. Markus Nickl von doctima. Was ich lernte: Aus Sicht der Suchmaschine sind die Inhalte der Technischen Dokumentation hochrelevant. Denn Google liebt Informationen, die gut strukturiert, einzigartig und wertvoll sind. Integrieren wir Produktinformationen in Unternehmenswebsite statt sie als PDFs oder auf statischen Websites zu veröffentlichen, können wir die Zugriffe auf die Unternehmens-Websites deutlich erhöhen. Für die moderne technische Redaktion bedeutet das keinen großen Aufwand, denn sie ist bereits vertraut mit Metadaten. Diese sollten für die situationsbedingte Verwendung auf Unternehmens-Website definiert werden. Das Marketing gewinnt mehrfach: mit qualitativ hochwertigem Content, der Vermeidung doppelter Inhalte und mehr Interaktionen auf der Website.

IN15. Fischer: Wenn Re-use King ist, sind Metadaten die Krönung

Beim Vortrag von Dr. Fischer über Metadaten wuchs ich erstmal um ein paar Zentimeter. Herr Fischer begann seinen Vortrag mit einem Zitat von Ulrike Parson: „Das klassische Handbuch ist nicht mehr tragfähig“. Und als ich sah, dass das Zitat auf der Folie direkt über dem von Bill Gates stand („Content is king“), wuchs ich noch ein bisschen mehr.

Herr Fischer gab uns einen Rundumschlag. Wie erfolgte die Dokumentation in der Vergangenheit, wo stehen wir heute, wo müssen wir hin? Heute sind die Qualität und Intelligenz von Informationen abhängig von ihrer Verfügbarkeit und situativen Relevanz. Damit wird es immer wichtiger, Informationen bereitzustellen, wenn sie benötigt werden. Dafür brauchen wir neue und intelligente Metadatenkonzepte.

Kommentare   

# Markus Nickl 2016-11-18 11:19
Danke, dass Sie in meinem Vortrag waren (und hier darüber berichten). Wir bei doctima haben jetzt auch unsere Eindrücke von der tekom-Jahrestagung aufgeschrieben http://blog.doctima.de/2016/11/4-0-die-tekom-jahrestagung-2016/

Herzliche Blogger-Grüße aus Fürth
Markus Nickl
Antworten
# Uta Lange 2016-11-18 11:31
Ich habe gerade Ihren interessanten tekom-Bericht gelesen. Sehr schön! Dass Sie unseren Blogartikel gleich mit verlinkt haben, freut uns natürlich sehr.

Herzliche Grüße zurück aus Hamburg,
Uta Lange
Antworten

Kommentar schreiben


  • facebook
  • linkedin
  • xing