Wiederverwendbarkeit um jeden Preis?

Das Prinzip der Wiederverwendbarkeit ist etwas, das die Software-Entwicklung und die technische Redaktion gemein haben: Redundanz ist böse ;-)

Deswegen macht es mir auch eher Spaß Entwicklern zu erklären, worum es bei meiner Arbeit vor allem geht: sie verstehen nämlich (meistens) ziemlich schnell, welche Probleme wir als Redakteure haben (und warum es Probleme sind!) und wie man die dann z.B. durch Verwendung von XML lösen kann.

Die Kolumne “Be pragmatic, not dogmatic” von Joachim Arrasz hat mich an einige Gedankengänge und Diskussionen zum Thema Wiederverwendung in der Doku erinnert. Die Essenz der Kolumne ist, dass man nicht um jeden Preis immer alles standardisiert und wiederverwendbar machen sollte. Denn am Ende könnten die Mühen dafür höher sein, als der eigentliche Nutzen.

Ich habe so einen Fall z.B. selbst erlebt/produziert. Als ich entdeckte, dass man in DITA auch auf Map-Ebene wiederverwenden kann und so also z.B. einzelne Kapitel wiederverwenden kann, war ich im Wiederverwendungshimmel. Also habe ich die Hilfe, an der ich damals schrieb, sehr sorgfältig in etliche Maps unterteilt – ich könnte es ja mal wiederverwenden. Der Nachteil an der Sache war, dass es nicht so ganz einfach ist den Überblick über so viele Sub-Maps zu behalten. Man muss nach ein paar Wochen erst einmal wieder durchschauen, was wohin referenziert wird etc.

Das Ende vom Lied war, dass ich bis zuletzt keine einzige dieser Maps wiederverwendet habe und mich eigentlich immer geärgert habe, wenn ich mit den vielen kleinen Maps arbeiten musste.

Fazit

Joachim sagt in seinem Artikel:

Die “spätere mögliche Nutzbarkeit” ist für mich sogar ein Showstopper. Dieses Argument habe ich schon so oft gehört, dass es mir in den Ohren klingelt. An dem Tag, an dem diese Wiederverwendbarkeit wirklich greifen würde, kann man immer noch das Refactoring anstoßen und sich zu diesem Zeitpunkt den Mehraufwand einholen.

Ich denke, man muss einfach sorgfältig nach Anwendungsfall entscheiden wie stark man seinen Standards bis zum Ende folgt. Das spätere Umarbeiten (Refactoring) kann durchaus günstiger sein. In meinem Fall wäre es sinnvoller gewesen auf den konkreten Anwendungsfall zu warten und dann eben Zeit zu investieren, die Maps umzustrukturieren.

Verwandte Artikel:
Kategorien: DITA,Erweiterter Horizont,Softwaredokumentation | 4 Kommentare

4 Kommentare bisher

RSS Feed abonnieren oder TrackBack 'Wiederverwendbarkeit um jeden Preis?'.

  1. 31. Oktober 2011 um 21:47 Uhr

    Mirko sagt,

    Hallo, also auch ich kann aus Erfahrung sagen, dass die Module zur möglichen Wiederverwendung schon sehr früh viel zu klein gewählt werden. Problem: Der Überblick geht verloren und so geht es am eigentlichen Ziel vorbei. Also wie vorgeschlagen den Aufwand bei Bedarf betreiben.
    Wobei ich aber auch dazu sagen muss, dass kleine Module die für die Wiederverwendung vorgesehen sind später auch bei der Übersetzung eine Rolle spielen, da nicht mehr alles, also auch keine 100%-Matches, übersetzt und bezahlt werden muss.
    Gruss,
    Mirko

  2. 1. November 2011 um 20:22 Uhr

    redakteuse sagt,

    Hi Mirko,

    danke für deinen Kommentar. Gut zu hören, dass nicht nur ich diesen Fehler gemacht habe. ;-)

    Die Übersetzungskosten sind ein guter Punkt, der sicherlich in das Für und Wider der Wiederverwendung mit hineinspielt – wobei da in einigen Fällen der 100%-Match sicherlich trotzdem günstiger ist als die halbe Stunde Modul-Pfriemelei.

  3. 2. November 2011 um 12:46 Uhr

    Pascal Kesselmark sagt,

    Quote: «…und wie man die dann z.B. durch Verwendung von XML lösen kann…»

    Mmm. Irgendwie frage ich mich, was XML mit dem Thema des Blogeintrages zu tun hat? Hier ist doch nicht der Syntax das Ausschlaggebende, sondern andere Faktoren wie:
    – Grösse der Informationsmodule (IM).
    – Ablage/Auffindbarkeit der IM –> Verschlagwortung, Ablagestruktur, Volltextsuche etc.
    – Toolunterstützung beim Schreiben, so dass bereits bestehende IM mit gleichem Inhalt “angeboten” werden.

    Vielleicht bin ich ja auf dem Holzweg, aber wieso kann man XML-Inhalte besser wiederverwenden?

  4. 2. November 2011 um 13:02 Uhr

    redakteuse sagt,

    Hi Pascal,
    das war vielleicht etwas missverständlich von mir. XML war ja hier nur eine Erwähnung im Nebensatz, und ein Beispiel. Das sollte nicht direkt im Zusammenhang mit der Wiederverwendung stehen. XML hat ja noch einige andere Vorteile, wie z.B. Trennung von Text und Layout.

    Du hast auf jeden Fall Recht mit den aufgezählten Faktoren – die gelten erst einmal unabhängig für Wiederverwendung, egal was für ein Quellformat man verwendet.

Einen Kommentar schreiben

Bitte seien Sie höflich und bleiben Sie beim Thema. Ihre E-Mail wird nicht veröffentlicht.