Wissensartikel

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.

Recently I read a wiki article about Malta. My friend Sarah wrote it. I knew Malta was a small island. I knew it was in the Mediterranean. What I did not know was that Malta was one of the smallest states in the world. I also learned that the capital of Malta is Valletta. Naturally I concluded that Valletta was located in Malta. Most of us would. Computers would not. Because the wiki article was not machine-interpretable. It had no semantic capabilities.

Inkonsistente Unternehmensterminologie erschwert Kommunikationsprozesse und führt zu Missverständnissen. Eine Software für die Terminologieverwaltung führt zu einer effizienteren Kommunikation im Unternehmen. Terminologiemanagement-Systeme verwalten unternehmensspezifische Benennungen. Sie ermöglichen es allen Abteilungen, auf die aktuelle Terminologie zuzugreifen und sich an der Festlegung neuer Benennungen aktiv zu beteiligen.

von Anne Hoffmann und Ann-Cathrin Mackenthun

In der agilen Software-Entwicklung werden Anforderungen nicht mehr in Pflichten- und Lastenheften geschrieben, sondern in Form von handlichen User-Stories festgehalten, die auf einer Karteikarte oder einem Bierdeckel Platz haben. Doch wie schreiben Sie kurze und knackige Anforderungen, die nützlich für die Entwickler sind und eine gute Basis für aufgabenorientierte Dokumentation darstellen?

Alles beginnt mit ein paar Seiten in Word, einem kleinen, überschaubaren Handbuch. Doch innerhalb weniger Jahre wächst der Umfang dieses Handbuchs auf mehrere Hundert Seiten, es kommen Produktvarianten und neue Produkte hinzu. Viele technische Redaktionen entscheiden sich ab diesem Zeitpunkt, von Word auf XML-basierte Dokumentation umzusteigen. Dabei kommt oft strukturierter FrameMaker als Bearbeitungsprogramm zum Einsatz. Doch wie wandeln Sie Word-Dokumente mit Hunderten von Seiten schnell und sicher in XML-basierte Dokumente für strukturierten FrameMaker um?

Oder: Wie man Geld verbrennt

Technische Dokumentation bedeutet, Informationen zu recherchieren und aufzubereiten. Zielgruppengerechte Informationsvermittlung soll es ermöglichen, ein Produkt zu nutzen oder einem Prozess zu folgen. Dabei steht die unmittelbare Verfügbarkeit der benötigten Information im Vordergrund. Oft soll eine Handlungsanweisung schnell zum Ziel führen. Es ist nicht zwangsläufig notwendig, dass der Anwender sein Handeln versteht und die zugrunde liegenden Mechanismen nachvollziehen kann. Wird eine komplexe Information jedoch regelmäßig nachgeschlagen, kann es sich auszahlen, ein vertieftes Verständnis der Materie anzustreben. Einmalig einen Tag für eine Schulung zu investieren, kostet Geld, kann sich aber auszahlen.

Suchen
  • linkedin
  • xing