Softwaredokumentation im Wiki für ein Logistikunternehmen

Ziel des Projekts war die Konzipierung und Erstellung einer Benutzerdokumentation für eine unternehmenseigene Software zur Unterstützung und Verwaltung von kaufmännischen und logistischen Geschäftsprozessen. Für die Dokumentation sollte ein vorhandenes MediaWiki eingesetzt werden.

Vorgehensweise und Methoden

Um die Dokumentation einheitlich zu strukturieren, die Inhalte für die Leser übersichtlicher aufzubereiten und einen Redaktionsworkflow abzubilden, mussten die Wiki-Artikel um semantische Informationen ergänzt werden. Zu diesem Zweck haben wir ein Semantic MediaWiki (http://semantic-mediawiki.org/) eingerichtet. Die Funktionalitäten und Metadaten wurden an die speziellen Anforderungen des Kunden angepasst:

Verschiedene Formulare ermöglichen die strukturierte Erstellung und Bearbeitung von Wiki-Artikeln entsprechend Informationsklassen. Die Informationsklassen orientieren sich am DITA-Standard (siehe http://dita.xml.org/standard): Aufgabenbeschreibung, Referenzinformationen und Konzeptbeschreibungen.
Die Formulare vereinheitlichen Struktur und Layout der Wiki-Artikel und ermöglichen es den Wiki-Autoren, Artikel ohne tiefere Kenntnis der Wiki-Syntax zu erstellen.
Spezielle Metadaten ermöglichen die automatische Erzeugung von Navigationselementen:
Inhaltsverzeichnisse für verschiedene Ebenen, Blätter-Schaltflächen und Index-Seiten.
Neben der Volltextsuche stehen den Lesern damit weitere Such- und Zugangsmöglichkeiten zur Verfügung.
Spezielle Abfragen sorgen für eine automatische Zusammenstellung von Links auf verwandte Themen.

Die unternehmenspezifische Terminologie und Schreibregeln wurden im Verlauf des Projekts definiert und ebenfalls in einem Wiki-Artikel gepflegt. Spezielle Seiten für Wiki-Autoren ermöglichen das Filtern von Themen nach Bearbeitungsstatus sowie das Verwalten von Indexeinträgen.

Last but not least wurden in Zusammenarbeit mit den Logistik-Experten die wichtigsten Aufgaben ausgewählt, die Nutzer der Logistik-Software zu bewältigen haben: Kalkulation von Logistikaufträgen, Bearbeitung von Ausfuhrpapieren, Rechnungslegung etc. Für die Benutzerdokumentation wurden zu jeder dieser Aufgaben Wiki-Artikel erstellt:

Jede Aufgabe wurde in einem aufgabenorientierten Wiki-Artikel beschrieben.
Die Aufgabenbeschreibungen wurden verknüpft mit den Beschreibungen der verwendeten Software-Dialoge. Jeder aufgabenorientierte Artikel hat somit Links zu den dazugehörigen Referenzinformationen.
Die Aufgabenbeschreibungen wurden verknüpft mit den Beschreibungen der zugrunde liegenden Konzepte, z.B. den Regeln für die Rechnungskalkulation.
Die Dialoge der Software wurden verknüpft mit den Referenzinformationen des jeweiligen Dialogs, d.h. es wurde eine kontextsensitive Hilfeanbindung hergestellt. Auf diese Weise springen die Benutzer beim Klick auf die Hilfe-Schaltfläche direkt zum richtigen Thema in der Dokumentation.

Einblicke

Über Fr. Meyer's Sohn (GmbH & Co.)

Fr. Meyer’s Sohn (FMS) ist ein globales Speditionsunternehmen in Familienbesitz. Weltweit gehört es zu den zehn größten Seefrachtspediteuren. Verkehrsträgerübergreifende Kundenlösungen gehören ebenso zum Produktportfolio wie die Optimierung von Lieferketten.