Wissensartikel

von Katrin Mehl und Elisabeth Fischer

Häufig vermitteln wir technische Informationen als Text. Je komplexer die Informationen, umso länger wird der Text. Dies kann ein Indiz dafür sein, dass die Informationen eine zusätzliche Darstellungsform verlangen, z.B. ein Bild. Bilder ermöglichen dem Leser eine visuelle Vorstellung von den Komponenten, Geräten oder anderen technischen Bauteilen.

Das Stichwort agil ist in der Softwareentwicklung mindestens so beliebt wie DITA in der Technischen Dokumentation. Kein Wunder: Agil und DITA konzentrieren sich auf Modularisierung und die Anforderungen der Nutzer. Dieser Artikel beleuchtet, wie agiles Dokumentieren in der Praxis funktioniert, welche Tools die Prozesse unterstützen und welche Vor- und Nachteile sich für ein Dokumentationsteam ergeben.

Von Ulrike Parson, CEO, parson AG, und Dr. Achim Steinacker,* Presales Manager, intelligent views gmbh

Klassischerweise wird Technische Dokumentation als Handbuch erstellt – für bestimmte Zielgruppen und Produktvarianten. Redaktionssysteme unterstützen Redakteure, Textmodule mit Metadaten zu versehen, sodass sie korrekt zu Handbüchern zusammengestellt werden können. Mit Industrie 4.0 und der stärkeren Modularisierung von Informationen ist handbuchbasierte Dokumentation jedoch nicht zukunftssicher.

Wissen spielt eine wichtige Rolle für den Erfolg eines Unternehmens. Es trägt dazu bei, Alleinstellungsmerkmale zu schaffen, und es ist eine zentrale strategische Ressource bei der Entwicklung und Vermarktung von Produkten und Dienstleistungen.

Es gibt viele Gründe, warum ein Unternehmenswiki scheitert: falsche Wahl der Software, fehlende Unterstützung der Geschäftsleitung, zu wenig Zeit für die Pflege. Dieser Artikel wird sich nicht mit all diesen Gründen beschäftigen, sondern sich auf unstrukturierte Inhalte und die Wiederauffindbarkeit von Artikeln konzentrieren.

Anna M. ist Software-Entwicklerin. Seit kurzem arbeitet sie bei einer Firma, die spezialisierte Erweiterungen für eine kaufmännische Standardsoftware verkauft. Für die Entwicklung dieser Erweiterungen soll Anna das API der kaufmännischen Software verwenden. Aber Anna hat ein Problem. Sie weiß nichts über das API – seine Struktur, die Schnittstellen, die angebotenen Funktionen. Denn das API ist sehr spärlich dokumentiert. Anna findet nur eine kurze Übersicht über die angebotenen Schnittstellen und spärliche Code-Kommentare in den Klassen.

Suchen
  • linkedin
  • xing