Dokumentation

Technische Dokumentation im Scrum-Team

Seite: 3/3

Anbieter zum Thema

Fortschritte machen und dabei den Überblick behalten

Redakteure müssen Inhalte auf eine Art und Weise erstellen und verwalten, die es erlaubt, die Dokumentation jederzeit anzupassen und zu liefern. Wenn Redakteure jedoch einzelne Kapitel oder Abschnitte aus dem Gesamtzusammenhang des Handbuchs an den Kunden abliefern, dann erscheinen diese oft zusammenhanglos. Darüber hinaus ist es mit einigem Aufwand verbunden, ein solches Handbuch überhaupt in einen akzeptablen Zustand zu bringen, um auch nur einen Draft zu liefern.

In der Praxis legen Redakteure leere Kapitel oder Bausteine an, die dann im Laufe der Sprints mit Inhalten gefüllt werden. Mit Statuszuweisungen können Redakteure den Überblick darüber behalten, welche Themen erledigt sind und welche noch nicht. Folgende Status sind denkbar:

Bildergalerie
  • Leer
  • In Arbeit
  • Im Review
  • Final
  • In Übersetzung

Hier bietet sich der Einsatz eines Redaktionssystems an, das den gesamten Lebenszyklus Technischer Dokumentationen vielfältig unterstützt.

Gut organisiert im Redaktionssystem

Ein Redaktionssystem bietet spezielle Funktionen, die Redakteure bei der Erstellung, Verwaltung und Publikation unterstützen. Um diese Funktionen bei der Erstellung von Inhalten im Scrum-Modus sinnvoll zu nutzen, sollte eine Informationsarchitektur entwickelt werden. Eine Informationsarchitektur ist eine Struktur, die Informationen sinnvoll gestaltet und damit im Ergebnis die Nutzung der Information für eine bestimmte Zielgruppe vereinfacht.

Im Zusammenhang mit Scrum sind die folgenden Funktionen, die agile Anforderungen umsetzen, besonders interessant:

  • Single Source Publishing: Wiederverwendbare Bausteine werden in einer Datenbank abgelegt. Diese Bausteine erlauben es, Dokumente flexibel zusammenzustellen und zeitnah zu publizieren.
  • Variantenmanagement: Bausteine, Grafiken und andere Medien wie Videos werden klassifiziert und mit den entsprechenden Metadaten versehen. So können Redakteure einem Baustein einen Status zuweisen, zum Beispiel eine länderspezifische Zuordnung. Eine zielgruppenorientierte Publikation ist so jederzeit möglich.
  • Versionsmanagement: Pro Sprint wird eine Version generiert und archiviert, so dass zu jeder Zeit nachvollziehbar ist, welche Funktionen dokumentiert sind und an den Kunden geliefert wurden.

Der Einsatz von Metadaten bei Single Source Publishing und Variantenmanagement erfordert ein Konzept, das alle Anforderungen an den Lebenszyklus von Dokumentationen oder anderen Inhalten abbildet. Solch ein Konzept garantiert zudem den sicheren Einsatz von wiederverwendbaren Bausteinen und den dazugehörigen Metadaten. Mit einer Filterfunktion können Sie zudem jederzeit einen aktuellen Draft publizieren.

Quellen:

[1] Baker, Mark: Toward an Agile Tech Comm, in: intercom November/December 2014, Seite 25 – 28

[2] Burkhardt, Remo Aslak, Informationsarchitektur, Januar 2008, DOI: 10.1007/978-3-540-69818-0_12 Source: OAI, https://www.researchgate.net/publication/36381063

[3] Gale, P. & Smith, K., Agile for Technical Communication, in: intercom November/December 2014, Seite 7-9

[4] http://agilemanifesto.org/iso/de/principles.html, (abgerufen 20.12.2016)

[5] International Standard ISO/IEC/IEEE 26515:2012(E): Systems and software engineering – Developing user documentation in an agile environment.

* Heike Bath. ist Mitinhaberin von people text – Technische Dokumentation. Im Team ist sie Spezialistin für Business-Kommunikation.

Artikelfiles und Artikellinks

(ID:44453375)

Jetzt Newsletter abonnieren

Verpassen Sie nicht unsere besten Inhalte

Mit Klick auf „Newsletter abonnieren“ erkläre ich mich mit der Verarbeitung und Nutzung meiner Daten gemäß Einwilligungserklärung (bitte aufklappen für Details) einverstanden und akzeptiere die Nutzungsbedingungen. Weitere Informationen finde ich in unserer Datenschutzerklärung.

Aufklappen für Details zu Ihrer Einwilligung