Nützlicher Helfer mit Abstrichen

Der Technische Redakteur ist tagtäglich mit unterschiedlichsten Anforderungen an seine Texte konfrontiert. Seien dies rechtliche Vorgaben und Normen, die „Verständlichmachung“ komplexer Inhalte oder die Gestaltung technischer Texte. Die CD-ROM „Technische Dokumentation“ des WEKA-Verlages verspricht hier Unterstützung auf breiter Front. Der Verlag empfiehlt diese Kurzversion des Onlineangebotes als täglich nutzbares Nachschlagewerk. Das wirtschaftliche Erstellen verständlicher und rechtskonformer Texte soll damit sehr viel leichter vonstattengehen.

Aufmachung und Usability

Titelseite Agile DokumentationUnscheinbar in der äußeren Gestaltung verrät allein der kurze Hüllentext was den Nutzer erwartet – eine Sammlung hilfreicher Praxis-Tipps und -Tricks zur technischen Dokumentation. Die CD selbst ist eine einfache CD-ROM mit Autostartfunktion, wie man sie seit gut 20 Jahren kennt. Die volle Funktionalität wird über einen Freischaltcode zugänglich gemacht. Ohne diesen ist lediglich das Inhaltsverzeichnis einsehbar. Die Freischaltung war in unserer Version übrigens nur nach Anforderung eines neuen Codes beim Verlag möglich, da der mitgelieferte partout nicht funktionieren wollte. Glücklicherweise waren die Mitarbeiter im Verlag aber schnell und unbürokratisch bei der Herausgabe eines Ersatzcodes. Angeblich handelte es sich hierbei um einen Einzelfall.
Die Nutzeroberfläche der CD stellt sich unspektakulär in einer branchenüblichen blau-weißen Farbkombination wieder. Das Design wirkt etwas altbacken – „1990er Jahre“ war hier meine erste Assoziation. Die Inhalte sind über eine Baumstruktur zugänglich, wie sie jeder PC- oder Apple-Nutzer vom Windows-Explorer respektive Apple-Finder kennt. Die Strukturierung ist schlicht und intuitiv verständlich. Die benötigten Texte sind nach kurzer Orientierung schnell zu finden. Erleichtert wird dies zudem durch die Suchfunktion, die zuverlässig die benötigten Treffer fand.
Ein praktisches Zusatzfeature ist der PDF-Export. Die einzelnen Kapitel lassen sich als PDF ausdrucken und sind somit u. U. leichter lesbar. Sehr schön: Man kann die Unterkapitel frei zusammenstellen und zu einem PDF zusammenfassen lassen. Das PDF selbst ist allerdings von nur durchschnittlicher Qualität. Die Artikel lassen sich auch direkt ausdrucken. Da die Fontgröße und das Layout aber nicht anpassbar sind, ist die Schrift im Ausdruck tendenziell zu klein.
Etwas umständlich ist auch das Zugreifen auf die CD-ROM. Mitunter ist hier mit langen Reaktionszeiten und dem – je nach Laufwerk – lauten Betriebsgeräusch zu rechnen. Dieser Effekt tritt selbst nach Installation der Software auf. Wenn die Reaktionszeiten in dieser Variante auch etwas kürzer sind, ist die Verzögerung doch spürbar. Eine alternative Vollinstallation der Texte auf dem eigenen Rechner wäre hier wünschenswert.

Praxistauglichkeit
Die Texte sind inhaltlich eingängig formuliert und bieten – wie beworben – viele hilfreiche Tipps zur praktischen Textarbeit in der technischen Dokumentation. Die Sammlung ist äußerst umfangreich. Sie umfasst vom Thema Strukturierung und Gestaltung der Texte über die Prozessgestaltung bis hin zu den wichtigsten aktuellen Rechtsnormen alles was der Redakteur benötigt. Sehr schön ist die Gliederung in einen theoretischen und einen praktischen Teil. In der Theorie werden die wichtigen Punkte ausführlich erläutert, über die man sich vorab Gedanken machen sollte. Die Konzeptionierung eines komplett neuen Textprojektes inklusive der Erstellung eines Prozessplanes wird damit Schritt für Schritt erläutert und begleitet. Übliche Fallstricke in der Konzeption, deren Auswirkungen erst später im Projekt zu spüren wären, lassen sich so leicht vermeiden.

Im praktischen Teil erleichtern konkrete Beispiele zu Textgestaltung und Formulierung den Zugang zum Inhalt. Gelegentliche Grafiken und sogar Karikaturen lockern die Texte zusätzlich auf. Hat man ein konkretes Problem findet man über die Suchfunktion ziemlich schnell die relevanten Artikel. Kennt man die Struktur der CD schon etwas, finden sich die benötigten Artikel auch sehr schnell.

Fazit
Die CD-ROM „Technische Dokumentation“ ist eine hilfreiche und wertvolle Sammlung zum Nachschlagen und Recherchieren. Hilft die CD also beim Erstellen neuer Dokumentationen? Auf jeden Fall. Wer auf der Suche nach bestimmten DIN-Normen ist oder wissen will ob gerade ein Gefahren- oder Sicherheitshinweis angebracht ist, für den ist dieses Nachschlagewerk eine große Hilfe.
Neulinge werden sich beim Erstellen technischer Dokumente über die vielen Tipps zu Sprache und Strukturierung freuen. Oftmals gesehene und wiederholte Fehler lassen sich so relativ unkompliziert vermeiden. Das etwas altbackene Oberflächendesign und die fehlende Möglichkeit die Daten auf die Festplatte zu installieren trüben aber die Nutzerfreude. Man sollte zudem bedenken, dass die enthaltenen Rechtsnormen mittelfristig veralten werden. Regelmäßige Updates sind also Pflicht.

Hinweis: Das hier besprochene Buch wurde uns vom Verlag kostenfrei als Rezensionsexemplar zur Verfügung gestellt. Der Verlag hat keinerlei Einfluss auf den Inhalt dieser Besprechung genommen.

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.