Warum ich SCSS nicht mehr missen möchte

Schickes CSS mit Sass

Schickes CSS mit Sass

Ich beschäftige mich mit Redaktionsprozessen und deren Optimierung. D. h. ich werde immer hellhörig, wenn es eine Chance gibt, etwas zu vereinfachen oder besser zu strukturieren.

In einem anderen Teil meines Jobs gestalte ich Online- und mobile Medien. Dort spielt HTML 5 eine große Rolle. Für dessen Gestaltung verwendet man CSS, und mit CSS habe ich als jemand, der in Strukturen denkt, ein Problem.

Mein Problem mit CSS

CSS bietet kaum Möglichkeiten, zu strukturieren. Es ist auf schnelle Verarbeitung durch den Browser hin optimiert, Wartbarkeit hat nicht Priorität. Im Wesentlichen bestehen CSS-Dateien deswegen aus einer linearen Abfolge von Regelsätzen, die bestenfalls in Blöcke für unterschiedliche Zielmedien gruppiert sind, also z.B. für Mobilgeräte oder Drucker. Alle Angaben sind explizit. Das bedeutet, jede Farbangabe, die mehr als ein Element betrifft, muss mehrfach identisch hingeschrieben werden. Es gibt keine Variablen. Damit werden komplexe Stylesheets schnell unübersichtlich und sind schwierig zu pflegen.

Eine Lösung

Konzeptionell lässt sich die Unstrukturiertheit von CSS nur rudimentär behandeln: Man kann die CSS-Regeln auf mehrere Dateien verteilen. Effektiver wäre es aber, CSS zumindest für die Erfassung um gängige Programmierkonzepte zu erweitern wie Variablen, Vererbung, Hierarchien oder Berechnungsfunktionen.

Tatsächlich haben sich seit Längerem mehrere Formate etabliert, die genau das leisten. Beispiele sind LESS, Coffeescript oder SASS. Das Format SCSS, das ich hier vorstellen will, ist eine syntaktisch andere Geschmacksrichtung von SASS. Diese Sprachen erlauben es, Regelsätze strukturiert zu erfassen, sind aber leider für Browser nicht lesbar. Deshalb werden sie mit sog. Präprozessoren ausgeliefert. Präprozessoren sind Konverter, die Dateien vor dem Ausliefern an den eigentlichen Prozessor (hier: den Browser) verarbeiten. Somit besteht SCSS aus zwei Komponenten:

  • einem Format, bei dem es sich um eine funktionale Erweiterung von CSS handelt.
  • einem Prozessor, der für unterschiedliche Betriebssysteme unter einer MIT-Opensource-Lizenz frei erhältlich ist.

Sassy CSS

Ich möchte die wesentlichen Features von SASS (die Abkürzung steht für „Syntactically Awesome Style Sheets“) bzw. SCSS („Sassy CSS“) hier nur kurz anreißen.

  • Regelsätze schachteln: Angaben beispielsweise für Links, die im Footer oder im Header stehen, lassen sich innerhalb des Regelsatzes für allgemeine Links platzieren, anstatt sich irgendwo über die CSS-Datei zu verteilen.
  • Abgeleitete Klassen: Formate für Warn- und Gefahrenhinweis-Boxen lassen sich von einer gemeinsamen, allgemeineren Klasse Hinweis-Box ableiten, anstatt alle Angaben zu wiederholen oder in mehrere gemeinsame und spezifische Regelsätze zu verteilen.
  • Ausgelagerte Dateifragmente, Partials: In sich geschlossene Teilbereiche, beispielsweise die Regelsätze für das Navigationsmenü, lassen sich in einzelne Dateien auslagern. Das geht auch mit CSS, wo aber jede ausgelagerte Datei im HTML-Kopf explizit referenziert werden muss. Der SCSS-Präprozessor fasst die Partials zu einer einzigen Datei zusammen, was sowohl die Verwaltung der Referenzen im HTML erleichtert als auch die Performance verbessert.
  • Variablen: Werte, aber auch ganze Regeln lassen sich in Variablen deklarieren. Wiederkehrende Gestaltungselemente oder CI-Farben lassen sich somit an einer Stelle verwalten und bei Bedarf zentral austauschen.
  • Operationen und Funktionen: SCSS stellt eine ganze Reihe von Manipulationen und Berechnungen zur Verfügung. Das Spektrum reicht von einfachen Farbänderungen wie darken($color) über Textfunktionen und Mathematik bis hin zur Verarbeitung von assoziativen Listen wie mit map_get($map, $key).
  • Mixins: Mixins sind aufrufbare Makros, denen man Parameter mitgeben kann. Um auf das Beispiel mit den Hinweis-Boxen zurückzukommen: Ein Mixin hinweisbox($severity, $symbol) kann die Darstellungsregeln für eine Hinweis-Box enthalten, mit Parametern für die Gefahrenstufe und das anzuzeigende ISO-Symbol. Die Gestaltung eines Gefahrhinweises mit Augenschutz kann sich dann auf den Aufruf @include hinweisbox(‚Gefahr‘,‘Laser‘) beschränken.

SCSS im Alltag

Wir verwenden SCSS mittlerweile seit mehreren Jahren in praktisch allen Projekten, in denen CSS eine Rolle spielt, und bereuen den Schritt in keiner Weise. Die Aufwände für Installation und Einarbeitung waren kaum der Rede wert. SCSS ist anders als SASS eine reine Erweiterung der CSS-Syntax, womit der Einstieg sehr schnell vonstattenging.

Die Features, die wir am meisten nutzen und die uns massiv Zeit ersparen, sind Variablen und Partials, die besonders in Projekten mit mehreren Layouts (Kunde und Tochterfirma, Eigenmarke und OEM) ihren Nutzen ausspielen. Und, ganz wesentlich: das Schachteln von Regelsätzen, das ein sinnvolles Strukturieren der Stylesheets erst ermöglicht und nebenbei sehr viel Schreibarbeit erspart.

Eine nicht zu unterschätzende Nebenwirkung dieser Strukturierung ist, dass wir automatisch sehr viel systematischer an die Gestaltung der Stylesheets herangehen als zu Zeiten, als wir nur einzelne Regeln hintereinander weggeschrieben haben. Da war es schnell passiert, dass der allgemeine Regelsatz für Links und der spezielle Regelsatz für Links im Footer tausend Zeilen weit auseinander standen. Mit SCSS erhöht sich die Wartbarkeit der Lösung deshalb ganz ungemein.

Was den Übersetzungsvorgang von SCSS nach CSS angeht: Wir haben das in den beiden Entwicklungsumgebungen, mit denen wir arbeiten, PhpStorm und Visual Studio, über Plugins so eingerichtet, dass der Präprozessor beim Speichern der SCSS-Datei automatisch anspringt. Das bedeutet, dass die generierten CSS-Dateien nebenbei und ohne unser explizites Zutun entstehen. Der administrative Mehraufwand besteht also vor allem im einmaligen Einrichten der jeweiligen Plugins.

Fazit

Wir haben SCSS für meinen Geschmack viel zu spät entdeckt, als es bereits jahrelang zur Verfügung stand. Mittlerweile ist es aber für mich und mein Team aus dem Arbeitsalltag nicht mehr wegzudenken, wenn es um Online- und mobile Medien geht. Auch wenn wir seine Möglichkeiten nicht bis ins Letzte ausreizen, sind bereits die wenigen Key Features, die wir ausführlich nutzen, eine erhebliche Erleichterung beim strukturierten Entwickeln und Warten von Stylesheets. Wenn Sie also mit CSS im Vanillegeschmack arbeiten, und gerne effizienter damit umgehen möchten, kann ich Ihnen dringend einen Blick auf SCSS empfehlen.

 

Startpunkt für Redaktion und Übersetzung

(c) Peter Smola pixelio.de

MIt den richtigen Werkzeugen für die Technische Redaktion und Übersetzung lässt sich so manche Hürde im Arbeitsalltag leichter bewältigen. Und es gibt ja auch jede Menge Hilfsmittel:

  • Übersetzungsspeicher
  • Terminologie-Datenbanken
  • Leitfäden
  • Online-Grammatiken
  • Sprachprüf-Software
  • und vieles mehr…

Studierende an der FH Wels in Oberösterreich haben im Sommersemester 2015 „Hilfsmittelbenutzung und Rechercheverhalten in der technischen Redaktion“ erforscht und daraus einen Überblick zu den Hilfsmitteln in der Technischen Redaktion und Übersetzung entwickelt. Die daraus entstandene Microsite ist ein hervorragender Einstieg für Neulinge in der Technischen Dokumentation und Übersetzung. Sie hält aber auch für den Profi noch den einen oder anderen Tipp bereit.

Vollständig ist die Microsite der FH Wels allerdings bei weitem nicht. Zum Beispiel fehlt bei den Sprachprüf-Werkzeugen unser ContentRuleset. Und leider gibt es auch keine Kontaktadresse, bei der man weitere Fundstücke einreichen kann. Schade, denn gut gepflegt hätte der Hilfsmittel-Überblick das Zeug dazu, eine zentrale Anlaufstelle für Technische Redakteure zu werden.

Übrigens: Auf die Welser Microsite wurde ich aufmerksam gemacht durch Klaus Schubert. Er ist Professor in Hildesheim und Herausgeber der Online-Zeitschrift transkom, einer weiteren wichtigen Ressource für Übersetzer.

Die besten Tools in der Technischen Redaktion?

Sandro Almir Immanuel / pixelio.de

Sandro Almir Immanuel / pixelio.de

Vor einiger Zeit hat mich Ferry Vermeulen von INSTRKTIV (zusammen mit mehreren anderen internationalen Experten) nach meinen drei beliebtesten Tools für die Technische Dokumentation gefragt. Gemeint waren nicht nur Software-Werkzeuge sondern ganz allgemein Hilfsmittel, auf die wir im Alltag nur ungern verzichten würden.
Zusammengekommen ist eine umfangreiche Liste, die die Vielfalt der Aufgaben und Bedürfnisse in der Technischen Dokumentation widerspiegelt. Einen eindeutigen „Sieger“ gibt es nicht. Bei siebzig befragten Teilnehmern ist MadCap Flare (20 Nennungen) mit weitem Abstand die häufigst genannte Software. Für diesen „ersten Platz“ dürfte MadCap Flare allerdings geholfen haben, dass sich unter den Teilnehmern drei MadCap Mitarbeiter und etliche MadCap Consultants befinden. Dennoch, MadCap Flare ist in der Branche ohne Zweifel ein beliebtes Tool.

Wie ich mich entschieden habe? Das lesen Sie am besten direkt auf der Seite von INSTRKTIV. Und vielleicht finden Sie ja noch die eine oder andere Tool-Anregung für Ihren Dokumentationsalltag.

Firefox auf RAM-Diät – Speichernutzung im Browser optimieren

15531453786_1368ed6118_o

(c) download.net.pl / flickr.com

Die meisten von Ihnen dürften das Problem kennen: Je länger man den Browser Firefox über den Tag nutzt, desto mehr RAM benötigt er auch. Für meinen Rechner mit 4 GB RAM bedeutet dies spätestens bei der Grafikbearbeitung Probleme, da Firefox zu viel Speicher belegt und damit die Performance in die Knie geht.

Für dieses Problem gibt es 3 Lösungen:

  1. Auf Chrome als Browser wechseln.
  2. Schließen und erneutes Öffnen des Browsers.
  3. Das Add-on Free Memory 2.0 nutzen.

Die Oberfläche des Chrome-Browsers finde ich nach Jahren der Firefox-Nutzung unhandlich, weswegen ich ihn nicht nutzen möchte. Mich persönlich hat das ständige Schließen und Öffnen des Firefox genervt. Darum habe ich ein Tool gesucht dass dies umgeht und Free-Memory 2.0 gefunden.

Free Memory 2.0 macht nichts anderes als dem Firefox-Befehl about:memory eine grafische Oberfläche zu verpassen. Für alle, die ihn nicht kennen: gibt man den Befehl in die Adresszeile des Browser ein, kann man die RAM-Nutzung manuell anpassen, den Cache sichern, Reports des RAM-Bedarfs anfertigen lassen etc. Dies ist jedoch etwas umständlich und wird durch Free Memory 2.0 vereinfacht.

Installieren und nutzen des Tools

Das Tool findet sich über die Add-on-Verwaltung des Firefox. Dort nach dem Add-on suchen: FreeMemory
Die Installation erfolgt automatisch mit einem Click auf den Button installieren.

Hat man das Add-on installiert erscheint ein kleines Icon in Form eines RAM-Riegels in der Befehlszeile. Klickt man dieses an, erscheint ein kurzes Menü. Über den Button Memory Minimization werden die laufenden Prozesse des Firefox entschlackt. Abhängig von der momentanen Nutzung des Firefox bringt dies mit 2 Klicks eine schnelle, wenn auch nur kurzfristige Abhilfe bei der RAM-Nutzung und eine Entlastung des Rechners.

FreeMemory2

600 Regeln für die Content-Qualität

doctima_contentruleset600 Regeln? Das kann doch kein Mensch im Griff behalten! Stimmt. Deswegen haben wir bei doctima das ContentRuleset entwickelt, eine Software, die Technische Dokumente systematisch auf unterschiedliche Prüffälle hin untersucht. Heute wollen wir einmal zeigen, was das ContentRuleset ist und was sich damit machen lässt.

Was ist das ContentRuleset?

Das ContentRuleset ist eine Sammlung von Regeln, die typische Prüffälle aus allen sprachlichen Ebenen und zu häufigen Prozessschritten abbilden. Die Prüfroutinen sind technologisch umgesetzt mit dem ISO/IEC-Standard ‚Schematron‘ (ISO/IEC FDIS 19757-3). Es integriert sich nahtlos in die Schematron-Schnittstelle des Content-Management-Systems SCHEMA ST4 (Version 2014 und 2016).

Mit dem doctima ContentRuleset geben wir Ihnen die Möglichkeit, das Schematron-Modul in ST4 zu einem leistungsfähigen Controlled-Language-Checker auszubauen durch …

  • ein elaboriertes Set an Prüfroutinen, das alle relevanten Qualitätsdimensionen für Content prüft. Und das bereits im Redaktionssystem – also noch bevor der Content zu einem Informationsprodukt verarbeitet wurde.
  • ein ausgeklügeltes Ordnungssystem, mit dem Sie die Routinen einfach und schnell verwalten und anwenden können.
  • eine funktionale Erweiterung des ‚ST4 Schematron Reports‘, die Ihnen das zielgenaue Detektieren und Beheben von Standardverletzungen vereinfacht.

Wer braucht es?

Das ContentRuleset adressiert den typischen Bedarf in der Technischen Redaktion. Es berücksichtigt Prüfkriterien aus den aktuellen Branchenstandards wie die tekom-Leitlinie ‚Regelbasiertes Schreiben‚. Dadurch ist das doctima ContentRuleset die ideale Lösung für Technische Redaktionen, die bereits mit ST4 arbeiten und die ihre Qualitätsprozesse optimieren und straffen wollen.

Das Content-Ruleset ist leicht zu handhaben und integriert sich nahtlos in den Arbeitsprozess. Der Katalog der Prüfroutinen lässt sich auf unternehmensspezifische Standards anpassen und bietet dadurch volle Flexibilität.

Wie bekommt man es?

Haben Sie Lust bekommen, das doctima ContentRuleset einmal in Aktion zu sehen? Möchten Sie mehr erfahren? Benjamin Rauschenberger beantwortet gerne alle Ihre Fragen; per Email an benjamin.rauschenberger@doctima.de und telefonisch unter 0911/97567027. Oder Sie vereinbaren gleich eine kostenlose Online-Präsentation auf unserer Produktseite. Wir freuen uns auf Sie!

Content-Qualität – am besten automatisch

Content-Qualität - ein dunkles Geheimnis (c) David Castillo Dominici via freedigitalphotos.net

Content-Qualität – ein dunkles Geheimnis
(c) David Castillo Dominici via freedigitalphotos.net

Es ist ein offenes Geheimnis in der Technischen Dokumentation: Die Qualität des Contents entscheidet über den Erfolg in der Produktkommunikation. An einer vernünftigen Qualitätssicherung hängt deshalb nicht nur das Image der Dokumentation und letztlich des Unternehmens; Fehler in der Qualitätssicherung bedeuten im Ernstfall finanzielle Schäden und Haftungsrisiken.

Und nun das dunkle Geheimnis in der Technischen Dokumentation: Für eine vernünftige Qualitätssicherung bleibt oft nicht genug Zeit. Obwohl wir wissen, wie wichtig die Qualitätssicherung ist. Und obwohl wir im Projektplan für die Anleitung ausreichend Korrekturzyklen vorgesehen haben. Was lässt sich also tun für mehr Content-Qualität?

Content-Qualität und die Kosten

Werfen wir zunächst einmal einen Blick auf die Kosten der Content-Qualität. Wobei: Kosten hat hier zwei Aspekte. Zum einen die Kosten, die wir aufwenden müssen, damit die Content-Qualität stimmt. Und zum anderen die Kosten, wenn die Qualität nicht stimmt.

Die Kosten, die wir für die Qualitätssicherung aufwenden müssen sind relativ leicht bestimmt. Wir gehen – je nach Qualitätsanspruch, den das Endergebnis benötigt – von etwa 10 % bis 30 % Projektanteil für Lektorat und Korrekturen aus. Das spiegelt sich auch 1:1 in den Kosten wider. Natürlich kann man hier Maßnahmen treffen, um die Effizienz zu steigern, dazu mehr weiter unten.

Mit den Kosten für schlechte Content-Qualität ist es dagegen so eine Sache. Sie sind ein wenig versteckt, was sie aber nur umso gefährlicher macht. Konzentrieren wir uns einmal auf eines der größten Kostenpotenziale: die Haftungsrisiken. Im Extremfall kann es, z. B. durch einen unsachgemäßen Warnhinweis, zu Personenschäden kommen. Personenschäden werden in Haftpflichtversicherungen typischerweise mit 5 Mio. € abgesichert. Wahlweise kann man hier also die Versicherungskosten ansetzen oder aber die Haftungssumme. Ich denke die Haftungssumme ist hier die richtige Ausgangsbasis, weil unklar ist, ob eine Versicherung wirklich leisten wird, wenn sie nachweisen kann, dass in der Qualitätssicherung vermeidbare Mängel vorliegen. Um zu den real anzusetzenden Kosten zu kommen, muss man nun die Haftungssumme noch mit der Eintrittswahrscheinlichkeit des Schadens-Ereignisses multiplizieren. Wie hoch diese ist, muss natürlich jedes Unternehmen für sich selbst entscheiden; je nach Vorbildung der Benutzer und Gefahrenpotenzial des Produkts ergeben sich hier unterschiedliche Werte.

Daneben gibt es natürlich noch weitere Kostenquellen: Erhöhte Supportaufwände, unnötige Kosten für Druck und Übersetzung (bei überflüssigem Content oder in Korrekturläufen), Image-Einbußen… Die Liste lässt sich fast beliebig verlängern.

Content-Qualität automatisieren

Am besten sind natürlich die Fehler, die erst gar nicht entstehen. Mit Standards in CMS und XML-Definitionen, mit Styleguides und mit einem gut funktionierenden Terminologie-Management lässt sich hier schon einiges erreichen. Aber letzten Endes bleibt immer ein Restrisiko, das sich nur durch eine gut funktionierende Qualitätssicherung minimieren lässt.

Hier gibt es einige organisatorische Hilfsmaßnahmen, mit denen sich die Qualitätssicherung erleichtern lässt. Wichtige Hilfsmittel sind zum Beispiel Korrektur-Checklisten, die neuen Mitarbeitern den Einstieg in die Qualitätssicherung erlauben und gleichzeitig im Review für Überblick und Dokumentation sorgen.

Am besten ist es aber, wenn sich der Content automatisch prüfen lässt. Mit Der Rechtschreibprüfung von Word arbeiten viele von uns tagtäglich. Und auch wenn wir wissen, dass sie im Einzelfall ihre Tücken hat, ist sie im Allgemeinen doch ein nützliches und angenehmes Werkzeug.

Für die Technische Dokumentation reicht das aber längst nicht aus. Denn Qualität definiert sich hier in der Einhaltung sehr feingranularer Standards, die jenseits von Grammatik und Rechtschreibung liegen. Wenn ich zum Beispiel sicherstellen möchte, ob die Warnhinweise ANSI-konform sind, muss ich die Informationsstruktur prüfen. Die Publikationsstruktur kommt ins Visier, wenn es darum geht, ob ein Informationsprodukt inhaltlich wirklich komplett ist. Wer mit standardisierten Zwischenüberschriften arbeitet, muss jede Informationseinheit gegen die erlaubten Formulierungen prüfen.

Für solche Szenarien haben wir deshalb das doctima ContentRuleset entwickelt – ein Werkzeug, mit dem sich XML-Content automatisiert prüfen lässt auf die Einhaltung von Standards, wie sie häufig in der Technischen Dokumentation eingesetzt werden. Dabei orientieren wir uns an anerkannten Branchenstandards wie der tekom Leitlinie „Regelbasiertes Schreiben“.

In einem der nächsten Beiträge zeigen wir genauer, wie unser ContentRuleset funktioniert. Wer sich vorher schon schlau machen möchte, erfährt hier mehr.

Connecting Content

doctima_contentconnectWar mein letzter Beitrag ein Plädoyer dafür, die wertvollen Inhalte aus der Technischen Redaktion an möglichst vielen Stellen wiederzuverwenden, möchte ich diesmal davon berichten, wie wir Sie bei der Erledigung dieser Aufgabe unterstützen können. In diesem Beitrag geht es darum, was unser neues Werkzeug ContentConnect leistet, welche Aufgaben es dazu bewältigt, und welche Vorteile Sie als Anwender daraus ziehen können.

Ziele: Was ContentConnect leistet

ContentConnect verbindet Content-Plattformen miteinander. Um das Grundprinzip des Werkzeugs zu verstehen, beschränke ich mich in diesem Beitrag auf den einfachen Fall mit einer Quelle (SCHEMA ST4) und einem Ziel (TYPO3). Mit der Fähigkeit, auch Inhalte aus mehreren Quellen zu kombinieren und die Ergebnisse in mehrere Zielsysteme zu verteilen, sind der redaktionellen Fantasie aber grundsätzlich alle Türen geöffnet.

Unseren ersten ContentConnect -Kunden ging es darum, Produktinformationen aus dem CMS der Technischen Reaktion nahtlos in die vom Marketing betreute Unternehmens-Website zu integrieren. Besucher der Website sollten Zugang zu den Produkten finden

  • über die Navigation durch die Hierarchie der Produktgruppen,
  • durch die indizierte Suche des Web-CMS und
  • einen „Product Finder“, also eine Facetten-Suche, wie man sie von großen Webshops her kennt.

Für den Anwender sollten sich die Produktinformationen nahtlos in die Web-Umgebung integrieren, sie sollten nicht bemerken, dass die Daten extern in das System eingespeist werden.

Inhalte: Was überträgt ContentConnect?

ContentConnect kopiert nicht einfach Daten. Er nutzt die im Content enthaltene Information, um einen wirklichen Mehrwert zu erreichen.

Strukturierte Informationen

Struktur einer Produktseite auf hilscher.com

Struktur einer Produktseite auf hilscher.com

Produktbeschreibungen sind strukturierte Information: Produktbezeichnung, Highlights, Technische Details, Bestellinformationen, Produktbilder, usw. werden als identifizierbare Bausteine übertragen. Diese lassen sich z. B. in Seiten-Templates eines Web-CMS einpassen. Systeme wie TYPO3 oder Contao unterstützen modulare Seiten-Layouts und bieten hierfür eine hervorragende Grundlage.

Mehrsprachigkeit

Ein zentraler Vorteil von Redaktionssystemen in der Technischen Redaktion ist das meist hervorragende Übersetzungs-Management. Gängige Web-CMS können gerade bei diesem qualitäts- und kostenkritischen Thema bei weitem nicht mithalten. ContentConnect überträgt alle Informationen in beliebig vielen Sprachen.

Metadaten

Produktinformationen im Redaktionssystem der Technischen Redaktion sind in der Regel mit Metadaten zu Filter- bzw. Ausgabezwecken angereichert. Sie geben zum Beispiel an, ob ein Produkt eine bestimmte Farbe hat, ein bestimmtes Betriebssystem unterstützt oder für einen speziellen Markt geeignet ist. Diese Metadaten lassen sich auch im Web verwenden, um z. B. mit einem Produktfinder einen zusätzlichen Zugang zu den Produkten zu schaffen, oder um den Navigationspfad durch Filter zu verschlanken. Wie wir das mit unserem Kunden Hilscher umgesetzt haben, können Sie unter den folgenden Links nachvollziehen:

Grafiken und Binärdateien

Produktbilder, Downloads, Infografiken: Grafiken und Binärdateien sind essenzieller Bestandteil des Contents und werden selbstverständlich mit bereitgestellt.

Querbeziehungen

Querbeziehungen zwischen Informationsbausteinen werden beim Transfer aufrechterhalten: Bei unserem Kunden waren das beispielsweise:

  • Hierarchien, z. B. die Einordnung in Produktgruppen,
  • Verweise auf zugehörige Produkte wie Zubehör oder Alternativen,
  • Links auf zugehörige Treiber-Downloads oder
  • eingebettete Bilder und Grafiken.

Generierte Inhalte

Nicht immer liegen alle Informationen, die im Zielsystem benötigt werden oder sinnvoll sind, in der Technischen Redaktion vor. Deshalb haben wir in ContentConnect vorgesehen, die zu übertragenden Inhalte regelbasiert anzureichern. Einige Beispiele:

  • Download-Links erhalten – abhängig vom Datentyp den Linkziels – PDF- oder DVD-Symbole.
  • Das Metadatum „unterstützte Technologien“ eines Produkts wird in eine Galerie von Logos dieser Technologien umgesetzt.
  • Telefonnummern in Kontaktadressen werden automatisch mit Telefon-Links versehen, die vom Smartphone aus bzw. über Skype o. ä. direkt angewählt werden können.

Aufgaben des Werkzeugs

Um die oben beschriebenen Inhalte abbilden zu können, erledigt der Content Connect die folgenden Aufgaben:

  • Benutzerauthentifizierung in Quell- und Zielsystemen,
  • Integration des ContentConnect in Quell- und Zielsysteme,
  • Objekte in Quell- und Zielsystem identifizieren und aufeinander abbilden,
  • Umsetzung von Quell- in Ziel-Datenmodell,
  • Konvertierung und Anreichern der Inhalte in Ziel-Markup,
  • Differenz-Upload für Grafiken und Ressourcen.

Alle Abläufe werden dabei vollständig über eine individuelle Konfiguration gesteuert. So können wir auf Kundenwünsche flexibel eingehen.

Vorteile aus Anwendersicht

Der Leiter der Technischen Redaktion bei unserem Kunden Hilscher hat die Vorteile des Systems aus seiner Sicht zusammengestellt und mit mir in einem Vortrag auf der tekom-Tagung 2015 präsentiert.

  • Für den Kunden erleichtert sich der Zugang zu den Produkten des Unternehmens. Filter und Produktfinder ergänzen die Navigation. Die umfassende, konsistente Information liegt in allen relevanten Sprachen vor.
  • Für den Vertrieb sinkt der Kommunikationsaufwand, während die Vertriebsqualität steigt. Ein gemeinsamer Blick auf die Website ermöglicht ein viel direkteres Eingehen auf den Kunden.
  • Das Marketing erhält eine Website mit umfassenden, mehrsprachigen Produktbeschreibungen, optimal für SEO-Zwecke, bei gleichzeitiger Arbeitsersparnis.
  • Das Produktmanagement kann leichter individuelle Highlight-Informationen bereitstellen.
  • Für den Controller verbessert sich das Übersetzungs-Controlling. Unnötige Aufwände durch Mehrfacherfassung von Technischen Daten, Produktbeschreibungen etc. entfallen, dagegen steigen Publikationsgeschwindigkeit und -konsistenz.

Weitere Informationen finde sich in unserem Foliensatz zur tekom Jahrestagung 2015 (H. Hentsch, E. Hellfritsch „Technische Redaktion als Marketing-Turbo“).

Zusammenfassung

Der generische Ansatz, den wir mit ContentConnect verfolgen, stellt die Informationsfülle der Technischen Redaktion unternehmensweit zur Verfügung. Nahtlos eingebunden in die native Datenhaltung des Zielsystems kann der vorhandene Content an vielen unterschiedlichen Stellen zusätzlichen wertvollen Nutzwert generieren.

Content Connected

Content Connected

Content Connected

Kürzlich gestand mir eine Technische Redakteurin: „…Und dann kopiere ich die einzelnen Technischen Daten in die Eingabemaske für die App und das Online-Portal. Das ist schon recht mühselig.“

Ein anderer Redakteur zeigte mir vor einiger Zeit seine Lösung: Er erzeugt aus seiner Redaktionslösung einige tausend statische HTML-Produktbeschreibungen, mit eigenem Navigationsbereich und allem, um das Ganze dann in einem iFrame in die Webseite einzukleben, die selbstverständlich dynamisch von einem Web-CMS (WCMS) erzeugt wird. Weder die Suchmaschine noch die Sprachumschaltung der Site sind angebunden. Optik und Bedienbarkeit sind damit -nun ja- diskutabel.

Solche und ähnliche Szenarien begegnen mir immer wieder. Was mich dabei fuchst: In beiden Fällen arbeiten Technische Redaktion und Marketing mit hochprofessionellen Werkzeugen und Methoden. Auf dem Weg zum Anwender verpufft aber die ganze schöne Effizienz an fehlenden Schnittstellen.

Schatzkiste Technische Dokumentation

Was leider oft übersehen wird: In der Technischen Redaktion entstehen mit professionellen Methoden und Werkzeugen hochwertige Inhalte:

  • Konsistente, qualitätsgesicherte und umfassende Produktinformationen,
  • Strukturierte Informationen, die personalisierte Darstellung bzw. Filterung erlauben – so entstehen aus demselben Ausgangsmaterial Sichten für Kunden, Partner, Mitarbeiter,
  • Hochwertige und durch Standardisierung kostengünstige Übersetzungen,
  • Professionell erstellte Grafiken und Bilder,
  • Metadaten, die z. B. über Facettensuche oder Kriterienfilter einen gezielten Zugang zum Produktportfolio ermöglichen.

Diese Inhalte werden häufig ausschließlich für die mit dem Produkt ausgelieferte Technische Dokumentation verwendet. Bestenfalls erstellt die Technische Redaktion auch Schulungsunterlagen und Produktblätter.

Profit für mehr Abteilungen

Wir haben uns diese Schnittstellen einmal systematisch angesehen und waren selbst überrascht, wie viele Unternehmensbereiche von diesem Datenschatz profitieren könnten. Insbesondere für Vertrieb und Marketing bieten sich vielfältige Optionen, die Informationen im Unternehmen weiter zu verwerten:

  • Produktbroschüren, Kataloge
  • Website, Shop
  • Produktpräsentations-Unterlagen
  • Reparatur- und Wartungsanleitungen
  • Support-Datenbank, Knowledge Base
  • Anforderungs-Management
  • ERP, PLM
  • … u. v. m.

Diese Informationsangebote entstehen zum überwiegenden Teil nicht in der Technischen Redaktion. Es gibt aber an zahlreichen Stellen Schnittmengen zu den Daten, die in der Technischen Redaktion erarbeitet werden. Nicht immer, und da sind wir wieder bei den Beispielen vom Anfang dieses Beitrags, findet allerdings an diesen Schnittstellen ein effizienter Abgleich statt.

Ein typisches Szenario sieht meist so aus:

  • Mehrfacherfassung und/oder Copy-Paste,
  • inkonsistente, teils widersprüchliche Stände zwischen den Medien,
  • fehlende Sprachversionen in einigen der Medien,
  • Verzögerungen und Koordinationsprobleme zwischen den Medien,
  • detaillierte Produktinformationen sind im Web nur als PDF verfügbar (Lokale Suchmaschine, Google, User Experience, etc.).

 

Aus diesen Erfahrungen heraus haben wir unser neues Produkt ContentConnect entwickelt. Mit ihm schaffen wir eine konfigurierbare Schnittstelle, um die Informationen aus der Technischen Redaktion an fast beliebiger Stelle automatisiert einbinden zu können. Zu den Details des ContentConnect und konkreten Einsatzbeispielen lassen wir demnächst einen eigenen Beitrag folgen.

Was ist neu in TYPO3 7.6?

TYPO3 7 CMS Backend

TYPO3 7 CMS Backend | Screenshot @steffenduesel

Nach sieben Sprint-Releases ist endlich die neue LTS-Version (Long-Term-Support-Version) von TYPO3 veröffentlicht worden. Sie wird voraussichtlich bis Ende April 2017 noch weiterentwickelt. Bis November 2018 sollen Sicherheitsupdates und wichtige Fehlerbehebungen als Update zur Verfügung stehen. Es lohnt sich aber schon jetzt einen Blick unter die Haube zu werfen und zu sehen, was sich Neues ergeben hat.

Höhere Performance

An der Performance von TYPO3 CMS wurde ziemlich geschraubt. Es wird nun der Composer Autoloader für PHP-Klassen verwendet. Wenn eine TYPO3-Installation mittels Composer installiert wurde, profitiert sie in vollem Umfang vom neuen Autoloader. Alle anderen Installationen funktionieren natürlich weiterhin, der alte Autoloader wird parallel beibehalten.

Spürbare Performanceverbesserungen sind auch beim Rendern von Fluid-Template-Dateien und ViewHelpern gemacht worden, die sich beim Rendern des Frontends sowie Backends durch einen schnellen Aufruf bemerkbar machen.

Verbessertes Backend

Gegenüber den offensichtlichen Änderungen am Backend-Design hat sich auch einiges im TYPO3-Core getan. So setzt das Backend nun auf Twitters Bootstrap auf und wurde um einige JavaScript-Bibliotheken erleichtert. Außerdem wurde das Backend auch für mobile Geräte aufbereitet. Statt nur die Ansichtsgröße auf das Display anzupassen, blendet das Backend hier nur noch diejenigen Elemente ein, die auf der aktuellen Viewport-Größe auch wirklich bedienbar und nützlich sind. Ansonsten wurde damit begonnen, den HTML-Code des Backends aufzuräumen und semantischer zu strukturieren.

Screenshot @steffenduesel

Screenshot @steffenduesel

Im Listen- und Seiten-Modul kann der Seitentitel nun auch inline geändert werden. Außerdem wurde die API für den Backend-Login überarbeitet. Diese kann nun flexibler mit externen Systemen wie z.B. OpenID umgehen.

Eine nette Spielerei: Backend-Nutzer können jetzt im Benutzerprofil einen Avatar hochladen, der dann im Changelog neben dem Namen angezeigt wird. Ansonsten kann man jetzt sehen, welcher Nutzer gerade eingeloggt ist. Auch die (Entscheidungs-)Dialoge wurden besser an das übrige User-Interface des Backends angepasst.

Um die Zusammenarbeit im Backend zu erleichtern, haben manche Einträge, wie z.B. die Inhaltselemente, ein internes Beschreibungsfeld bekommen, das nur im Backend angezeigt wird. Hier können Nutzer zusätzliche Informationen hinterlegen, die bei der Bearbeitung beachtet werden sollen.

zu guter Letzt eine gute Nachricht für SVG-Fans: SVG-Grafiken werden jetzt per default unterstützt und können im Backend eingebunden werden.

Weitere Erneuerungen

Mit der neuen TYPO3 CMS Version wird ein neuer Inhaltstyp Namens „Fluid Styles Content“ eingeführt. Damit können TYPO3-Entwickler nun standardmäßig Inhaltselemente ausgeben, indem sie mit Fluid arbeiten. Komplexer TypoScript-Code ist damit nicht mehr notwendig.

Man kann jetzt Dateien in der FAL Dateiliste ersetzen, wobei der alte Dateiname beibehalten oder wahlweise der neue verwendet wird. Zudem enthält das Install-Tool ein neues CleanUp-Tool, mit dem sich FAL-Dateien löschen lassen.

Das letzte Feature, das ich hier erwähnen möchte, ist die Optimierung beim Update von Erweiterungen. Bislang installierte der Erweiterungsmanager immer die neueste verfügbare Version der Erweiterung. Nun erscheint jedoch erst ein Dialogfenster, bei dem man die Version zum Update wählen kann.

Fazit

Visuell zeigt sich TYPO3 in einem frischen, zeitgemäßen Design. Durch den gleichen Aufbau finden sich auch Redakteure, die mit älteren TYP3-Versionen gearbeitet haben, schnell wieder ein.

Der Code im TYPO3-Core ist nun moderner und schlanker. Durch die neuen APIs und das Entfernen veralteter Komponenten ist die Anpassung für Entwickler flexibler geworden. Durch die modernen Technologien, die TYPO3 einsetzt, steigt auch die Sicherheit.

Vom Entwickler-Standpunkt aus wird die Entwicklung von Erweiterungen für TYPO3 7.6 sicherlich neue Herausforderungen geben, liefert aber mit dem aktuellen TYPO3-Core gleichzeitig eine gute Palette neuer APIs dafür.

Alte Zöpfe – neue Chancen

Kein alter Zopf (c) Helmut J. Salzer / pixelio.de

Kein alter Zopf
(c) Helmut J. Salzer / pixelio.de

Letzte Woche haben wir einen erschütternden Einblick in die Tiefen der TYPO3-Altlasten gegeben. Zugegeben: Letzten Endes kann TYPO3 nichts für die mangelnde Update-Bereitschaft seiner Benutzer; bei Drupal-, WordPress- und Joomla-Installationen sieht das auch nicht anders aus.
Deshalb wollen wir uns in diesem Post ansehen, welche Chancen das Update auf TYPO3 6.2 bietet. Und natürlich die versprochene Auflösung bringen, warum 4.5 manchmal mehr ist als 6.

Mehr Bequemlichkeit und Sicherheit

Auf die Sicherheitsaspekte beim Umstieg auf TYPO3 6.2 sind wir schon im letzten Beitrag eingegangen. Hinzu kommen zahlreiche Neuerungen auf technischer Seite (z. B. die Einführung des File Abstraction Layer oder die Umstellung auf MySQLi). Und man gewinnt eine Menge an Bequemlichkeit in der Handhabung: definierbare Displaybreiten in der Seitenvorschau (für responsive Seiten), automatische Content-Veröffentlichung im Scheduler, einfachere Formularerstellung im Form Wizard. Schon die neuen Features lohnen also den Umstieg. Daneben gibt es aber noch andere Chancen, die ein Upgrade auf TYPO3 6.2 bietet.

Responsive, Adaptive – Hauptsache -ive

Auch wenn es jetzt nicht so heiß gegessen wird, wie manche das gekocht haben: Google bewertet in Zukunft Webseiten auch danach, ob sie auf mobilen Geräten sinnvoll nutzbar sind, also z. B. adaptive oder responsive reagieren.
Für die weniger Webtechnik-Affinen unter Ihnen:  Beide Techniken verwendet man zur Anpassung einer Website an das gerade verwendete Anzeigegerät. Adaptive heißt dabei, dass die Anpassungen bereits vor dem Ausliefern der Seite an den Browser, also auf dem Server, passieren. Das ist wesentlich flexibler, aber auch aufwendiger.

Deshalb verwendet man häufig das einfachere responsive Design. Hierbei entscheidet sich erst im Browser, wie eine Seite dargestellt wird. Der Nachteil dabei: Der komplette Inhalt muss ausgeliefert werden, egal ob er in der entsprechenden Darstellung auch  gebraucht wird.Google ist es übrigens prinzipiell egal, für welche Variante Sie sich entscheiden. Mit adaptiven Verfahren laufen Sie aber wesentlich weniger Gefahr in andere Google-Fettnäpfchen wie lange Download-Zeiten oder unnötige Übertragungen zu treten.

Egal, für welche Technik Sie sich entscheiden: Eine mobile Darstellung ist fast immer Pflicht. Und das TYPO3-Update ist der ideale Zeitpunkt dafür. Erledigen Sie alles in einem Aufwasch. Denn oft ist Nutzen und Potenzial nicht ganz so groß, wie Sie die Web-Agentur gerne glauben machen will. Ob Sie Ihre Bierflaschenreinigungsanlage oder den neuen Herzschrittmacher gut verkaufen, steht und fällt wahrscheinlich nicht mit Ihrer mobilen Seite…

Endlich sozial

Social-Media ist wichtig, das weiß heute jeder. Aber was hat Social Media mit TYPO3 zu tun? Mehr, als man denkt: Moderne Extensions wie SocialSharePrivacy  sorgen für perfekte Integration der Social-Media-Angebote und gleichzeitig für die Einhaltung der aktuellen Datenschutzrichtlinien.
Social Media in die Website zu integrieren bringt allerdings nichts, wenn sich nichts tut auf den sozialen Plattformen. Letzten Endes haben Sie nur drei Optionen: Entweder Sie nehmen sich (a) Zeit oder geben (b) anderen Geld oder lassen es (c) ganz. Interessanterweise hat gerade bei einem schon fast intimen Vorgang wie der Kommunikation mit Besuchern per Social Media eine externe Agentur meist sowohl die besseren Themen als auch höhere Durchhaltevermögen. (Teilweise) Auslagern ist deshalb nicht die schlechteste Idee.

Die Lösung zu 6 ist kleiner als 4.5

Sollten Sie nicht wissen, wovon ich rede, empfehle ich den Beitrag „TYPO3-Altlasten“ aus der vergangenen Woche. Kurz zusammengefasst: Unsere kühne Behauptung war, dass 4.5 manchmal mehr ist als 6.0. Dazu sollte man Folgendes wissen.
Im Moment gibt es zweieinhalb Versionen von TYPO3, die mit Updates versorgt werden. 6.2 ist das aktuelle LTS-Release. LTS steht hierbei für „Long Term Support“ und bezeichnet Versionen, die besonders lang aktualisiert werden und sich dadurch besonders für den Einsatz im professionellen Umfeld anbieten. Die aktuelle Version 7 ist keine LTS-Version und wird deshalb nicht so lang unterstützt.
Die gerade ausgelaufene LTS-Version 4.5 hat im März ihre letzte Unterversion mit der Nummer 40 bekommen. Für 4.5 gibt es – als absolutes Novum im TYPO3-Umfeld und von der TYPO3-Gemeinde nicht gerade gern gesehen – nur noch bezahlte Updates. Für 5000 Euro pro Instanz bekommt man hier eine Gnadenfrist bis März 2016. Da Version 6.0 keine LTS-Version war, wurde sie nur kurz (ca. sechs Monate) mit Updates versorgt. Und daraus folgt: 4.5 LTS ist besser – da länger unterstützt – als Version 6.0.