Blog

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. mehr ...

Gewinnspiel: Eine Tasse auf Reisen #5

Brrr…in Hamburg ist der Winter eingekehrt und Weihnachten steht vor der Tür. Die parson-Tasse lässt sich währenddessen die Sonne auf den roten Bauch scheinen. mehr ...

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. mehr ...

tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung. mehr ...

tekom-Impressionen Teil 1: Improvisationstechniken, Fluff Hunt und Videos

Auf dem Weg zur Konferenz sehe ich an der Fassade des Stuttgarter Bahnhofs ein Zitat von Hegel: „daß diese Furcht zu irren schon der Irrtum selbst ist“. Genau darum ging es in Anthonys Apodacas Vortrag am Morgen des zweiten Konferenztages. mehr ...

UA Europe - Trends der Technischen Dokumentation

Am 15. und 16. Juni fand die diesjährige Conference for Software User Assistance Professionals in Dublin statt. Eine tolle Veranstaltung mit interessanten Themen rund um agile Entwicklung, kollaboratives Arbeiten, mobile Dokumentation und Usability.

Eröffnet wurde die Konferenz mit einer Podiumsdiskussion zu aktuellen Trends und Technologien der Technischen Dokumentation. Auf dem Podium saßen Vertreter der führenden Toolhersteller für technische Dokumentation. Als Moderatorin fungierte Leah Guren von Cow TC. Podiumsteilnehmer waren: George Bina (Syncro Soft), Mike Hamilton (MadCap Software), Ankur Jain (Adobe Systems), Jacquie Rhodes (3di Information Solutions) und Dennis Zhuravlev (Dr. Explain).

Hier eine persönliche Zusammenstellung von Diskussionsinhalten, ohne Anspruch auf Vollständigkeit:

Frage: Wie unterscheidet sich mobile Dokumentation von anderen Dokumentationsarten?

Antworten/Meinungen: Mobile Dokumentation muss sich anders verhalten als herkömmliche Online-Dokumentation. Dabei sind u.a. folgende Kriterien wichtig:

  • Die Dokumentation muss sich an berührungsempfindliche Bildschirme und an Bildschirme mit geringer Größe anpassen. Das bedeutet das Ende der 3-teiligen Hilfefenster (tripane help), wie wir sie von Windows kennen. Ein ausklappbares Inhaltsverzeichnis und Breadcrumbs vertragen sich nicht mit mobilen Displays.
  • Überflüssige Inhalte wie z. B. große Screenshots müssen aus der Dokumentation entfernt werden.
  • Die Hilfe muss sich besser in die Software integrieren, sodass der Benutzer nicht erst auf eine Hilfeschaltfläche klicken muss, um die Hilfe zu starten.
  • Die Inhalte mobiler Dokumentation sollten geringer im Umfang und zielgerichteter sein.

Eine große Herausforderung dabei sind die vielen verschiedenen Plattformen, die heute unterstützt werden müssen: PC, Internet, Tablets, Smartphones. XML stellt zwar eine hervorragende Basis für die Inhalte dar, die Transformationen müssen jedoch trotzdem an die verschiedenen Endgeräte angepasst werden. Dabei gibt es derzeit zwei verschiedene Herangehensweisen:  Die Dokumentation passt sich automatisch dem erkannten Gerät an oder es wird ein Redirect-Mechanismus umgesetzt, der den Benutzer zu der gerätespezifischen Hilfe leitet.

Die Anpassung an das Gerät und die Benutzungssituation fasste Ankur Jain mit dem schönen Satz zusammen:

„If content is king, then context is queen."

Die Dokumentation muss sich also dem Benutzungskontext anpassen, nicht nur hinsichtlich des Layouts, sondern auch hinsichtlich des Inhalts.

Es wurde klar, dass mobile Dokumentation in den Anfängen steckt. Wie in den Anfängen des Internets wird noch ausprobiert, was für Benutzer von mobiler Dokumentation gut funktioniert. Gestaltungsrichtlinien entwickeln sich gerade erst.

Frage: Wie können die Tools eine bessere Integration der Hilfe in die Anwendung unterstützen?

Einen wichtigen Gedanken dieses Diskussionsteils fand ich den Vorschlag, weniger verschiedene Hilfequellen anzubieten – heute hat man bei einigen Anwendungen die Wahl zwischen Online-Hilfe, Knowledge Base, Benutzerforum und Support-Portal. Alle diese Inhalte sollten über einen einzigen Zugriff durchsuchbar sein. Hier ist die Leistungsfähigkeit der Suchfunktionen von entscheidender Bedeutung.

Es wurde auch die Frage gestellt, wie zuverlässig benutzergenerierte Inhalte aus Foren tatsächlich sind und ob Hersteller, statt diese Inhalte einfach in die Hilfe zu verlinken, nicht lieber die Foren beobachten und technisch korrekte Hinweise in ihre Hilfe übernehmen sollten.

Einige der Podiumsmitglieder sprachen sich für eine engere Integration der Hilfe in die Anwendung aus – die Hilfe solle automatisch Vorschläge unterbreiten (analog zu Entwicklungsumgebungen, die automatisch Parameter für aufgerufene Methoden anbieten) oder sogar die Aktionen des Benutzers vorhersehen, um vorbeugende Hilfestellungen anzubieten. Leah Guren äußerte hier ihre Befürchtung, dass damit die nächste (intelligentere) Version der Windows-Büroklammer am Horizont lauern könnte.

Frage: Ist gedruckte Dokumentation noch erforderlich?

Hier war die eindeutige Antwort: Ja!

Dafür gibt es nach den Ansichten der Podiumsteilnehmer mehrere Gründe:

  • Rechtliche Anforderungen
  • Die Notwendigkeit, Zugangsmöglichkeiten für Menschen zu bieten, die nicht am Bildschirm lesen können
  • Weite Verbreitung des Mediums „Papier", das viele Menschen immer noch sehr gerne verwenden und das deshalb nicht innerhalb kurzer Zeit aus dem Gebrauch verschwinden wird

Kommentar schreiben


  • facebook
  • linkedin
  • xing