Beratung + Schulung

Beratung und Schulung

Verstehen lernen heißt begreifen können.

Sie müssen Dokumentationen ökonomisch erzeugen und zeitnah zur Verfügung stellen, mit Inhalten auf dem Stand der Technik. Unser Weg dahin:

  • Bestehende Inhalte prüfen
  • Möglichkeiten der Standardisierung nutzen
  • Prozesse optimieren
  • CMS- oder DTP-Software effizient einsetzen

 

Erfahrene Spezialisten und etablierte Methoden gewähren Ihnen bestmögliche Beratung. Bei Dokuwerk gehen Redaktions- und Übersetzungsprojekte Hand in Hand. Profitieren Sie von unserer Erfahrung mit den damit verbundenen Anforderungen an Systeme und Prozesse.

 

Unsere Beratungsleistungen für Kataloge haben wir in der Rubrik Produktkataloge beschrieben.

SCHEMA ST4

Profitieren über ein Projekt hinaus - unser ST4 Know-how

Das Redaktionssystem SCHEMA ST4 ist ein etabliertes XML-basiertes Content-Management-System (CMS). Wir sind Schema Partner und von Schema zertifiziert als Berater, Dienstleister und Übersetzungsdienstleister.

 

In einer Reihe von Projekten haben wir SCHEMA ST4 erfolgreich eingeführt. Für zahlreiche Kunden arbeiten wir auf deren ST4 Installationen. Für Unternehmen, die über keine eigene Redaktionsabteilung verfügen und diese Leistung outsourcen, halten wir ST4 Installationen vor. Mit unserer Erfahrung und unserem Know-how in Redaktions- und Übersetzungsprozessen können wir Sie bei der Einführung von ST4 praxisnah beraten und unterstützen:

 

  • Datenmigration

Wir untersuchen die bestehenden Daten, prüfen die Struktur und migrieren die Inhalte nach ST4. Wurden die Dokumente mit konsistenter Struktur erstellt, z. B. über definierte Absatzformate, können die Inhalte über ein Mapping migriert werden. Häufig bietet sich bei diesem Schritt auch eine grundlegende Überarbeitung der Texte an.

 

  • Systemkonfiguration

Wir nehmen für Sie die Grundkonfiguration in ST4 vor. Dabei steckt die Arbeit weniger im Anlegen von Metadaten, Taxonomien, Filtern, etc., sondern in der Voranalyse: Welche Konfiguration wird Ihren Anforderungen gerecht?

 

  • Publikationsstrecken

In SCHEMA ST4 werden nach der Erstellung der Inhalte sogenannte Knoten in Form eines Projektes aggregiert, z. B. für eine Betriebsanleitung. Diese Projekte können dann in verschiedene Formate publiziert werden z. B. als PDF oder in HTML, Word, Indesign, u. a. m. Mit dem ST4 Page Layout Designer erstellen wir für Sie die Publikationsstrecken.

 

  • Installation und Support als Schema Partner

Als Schema Vertriebspartner sind wir auch Schema Reseller. Wir führen für Sie die gesamte Abwicklung durch: Von der Installation über die Einführung bis hin zum laufenden Support.

 

Mehr dazu erfahren Sie auch unter: dokuwerk.de/schema.

Dokumentanalyse

Schwachstellen präzise benennen

Ihre Dokumente werden von uns auf klassifizierbare Schwachstellen untersucht:

  • Verständlichkeit
  • Konsistenz in der Formulierung
  • Text-Bild-Zusammenhang
  • Zielgruppenorientierung und weitere Punkte mehr.

Das methodische Gerüst hierfür liefert die Problemtypologie. Diese Methode, entwickelt von Prof. Schäflein- Armbruster (Hochschule Furtwangen), enthält einen umfassenden Katalog typischer Schwachstellen in technischen Dokumentationen. Systematisch werden alle Aspekte erfasst und präzise benannt. Das Ergebnis bildet die Grundlage für eine Optimierung.

 

Besonderes Augenmerk wird auf die Normenkonformität und die juristischen Anforderungen an die Dokumentation gelegt. Mehr dazu finden Sie weiter unten im Abschnitt Normen und Richtlinien >

 

Bei umfangreichen Dokumenten genügen häufig exemplarische Ausschnitte, um sich ein Bild über Schwachstellen und Optimierungspotenziale zu machen. Unsere Analyse muss daher nicht aufwändig sein, bietet Ihnen aber einen sehr guten Einblick in den Stand Ihrer Dokumentationen. Das Ergebnis erhalten Sie mit erläuternden Kommentaren und konkreten Verbesserungsvorschlägen.

Konzeption

Funktionsdesign - Qualität braucht Standards

Das Funktionsdesign ist eine etablierte Standardisierungsmethode für die technische Dokumentation, entwickelt von Robert Schäflein-Armbruster und Jürgen Muthig. Mit dem Funktionsdesign steht ein Verfahren bereit, um die Konsistenz und ökonomische Standardisierung einer Dokumentation zu sichern. Ein zentrales Prinzip der Methode ist es, die Dokumente aus sogenannten funktionalen Elementen aufzubauen und diese klar nach einheitlichen Beschreibungsmustern zu definieren.

 

Konkrete Anwendung - auf Ihre Anforderungen

Das Funktionsdesign wird in unseren Redaktionsprojekten konsequent angewendet. Ein Dokuwerk eigener Redaktionsleitfaden stützt die Anwendung der Methode. Wir entwickeln für Sie ein Funktionsdesign, zugeschnitten auf Ihre Dokumentarten, Zielgruppen und im Hause vorhandenen Systeme oder Tools. Das ausgearbeitete Funktionsdesign wird in einem Redaktionsleitfaden dokumentiert.

 

Redaktionsleitfaden

Der RLF - Abbild der Redaktionsarbeit

Die Regeln zur Anwendung des Funktionsdesigns werden in einem Redaktionsleitfaden erfasst. Ein umfassender Redaktionsleitfaden beschränkt sich jedoch nicht nur auf die Anwendung der Schreibregeln und Standards, er bildet die Arbeit der Redaktionsabteilung ab:

  • Vorgaben und Prozesse werden erklärt und mit Beispielen versehen, damit können Redakteure an die strukturierte Arbeit herangeführt und neue Mitarbeiter schneller eingearbeitet werden.
  • Qualitätsmaßstäbe der Redaktion werden transparent gemacht.
  • Die Anwendung eines Redaktionssystems, dessen Nutzung z. B. Editor, Struktur des Datenpools, etc. sind erläutert.

 

Der RLF ist damit ein zentrales Instrument, effiziente Arbeitsweisen einzuführen und Kosten zu reduzieren.

Grafikleitfaden

Standardisierte Grafikproduktion

Mit der Einführung eines Redaktionssystems werden für Textinhalte in der Regel Standards entworfen. Die Textproduktion wird durch Autorensysteme und Redaktionsleitfaden unterstützt. Der Grafikleitfaden ist das Pendant dazu. Er unterstützt die Bildproduktion, führt zu einem einheitlichen Erscheinungsbild und stützt die Wiederverwendung von Grafiken. Häufig ist er ein Bestandteil des Redaktionsleitfadens.

 

Typischerweise finden sich u. a. folgende Festlegungen in einem Grafikleitfaden:

  • Grafikformat
  • Auflösung (relativ und absolut)
  • Farbraum
  • Strichstärken
  • Größe des Weißraums um das dargestellte Objekt
  • Maßstab
  • Ansichten (frontal, seitlich, räumlich)
  • Werkzeug zur Grafikbearbeitung
  • Benennungskonventionen
  • Kompressionsmethode
  • Erstellungsprozess

 

Neben diesen formalen Definitionen sind in einem Grafikleitfaden auch funktionale Anforderungen enthalten, wie sie das Funktionsdesign benennt:

  • Verwendungszweck der Grafik: Inventar, Instruktion, Resultat
  • Einsatz von Lupen
  • Umgang mit Symbolen und Piktogrammen
  • Verwendung von Pfeilen und weitere Stilmittel

 

Mit unserer Expertise in der Grafikkonzeption unterstützen wir Sie darin, einen Grafikleitfaden passend für Ihre Anforderungen zu entwickeln.

Normen + Richtlinien

Konformität. Mit Sicherheit.

Hersteller müssen beim Inverkehrbringen Ihrer Produkte eine Fülle von nationalen und internationalen Richtlinien und Normen berücksichtigen. Diese haben auch Relevanz für die technische Dokumentation.

 

Haftungsrisiken minimieren – Dokumente prüfen

Trotz noch so sorgfältiger Konstruktion- häufig ergeben sich Restrisiken im Umgang mit dem Produkt. Betriebsanleitungen, Gebrauchsanweisungen, Einbauanleitungen etc. müssen solche möglichen Risiken klar und verständlich benennen und Maßnahmen zur Vermeidung von Gefährdungen aufführen. Es geht also um den möglichst weitgehenden Ausschluss eines Haftungsrisikos.

 

Wir prüfen Ihre Dokumentation:

  • Welche Anforderungen sind relevant?
  • Welche produktspezifischen Richtlinien und Normen sind berücksichtigt?
  • Welche Restrisiken wurden gemäß Risikobeurteilung ermittelt?
  • Wie werden die Risiken in der Anleitung hervorgehoben, behandelt und abgebildet?

Sie erhalten ein fundiertes Feedback mit konkreten Verbesserungsvorschlägen. In der Regel geht die Prüfung mit einer grundlegenden Analyse der Dokumentation einher.

Modularisierung + „smarte“ Navigation

Smartphones wollen Topics

Mit der zunehmenden Verbreitung von Dokumentationen auf Smartphones und Tablets müssen die Anforderungen an eine Modularisierung von Inhalten weiter gefasst werden: Bislang wurde unter Modularisierung vor allem die Abgrenzung der Inhalte in wiederverwendbare Einheiten verstanden. Sind diese „Module“ topic-orientiert erfasst, bilden die Inhalte in sich geschlossene sinnvolle Einheiten.

 

Unser smartes Konzept

Ein von uns entwickeltes Modularisierungskonzept berücksichtigt diese Anforderungen an eine sinnvolle Granulierung der Inhalte und die Möglichkeiten, die ein Redaktionssystem bietet, z. B. in Form von

  • Fragmenten
  • Filtern
  • Taxonomien, etc. 

Sollen Anleitungen auch auf kleinen Bildschirmen wie Smartphones sinnvoll dargestellt werden, müssen die Anforderungen noch genauer gefasst werden. Um längere Handlungssequenzen sinnvoll darzustellen, müssen diese in Einzelschritte zerlegt werden. Auch die beliebte Zusammenfassung von Daten in umfangreichen Tabellen muss auf Machbarkeit geprüft und Alternativen angedacht werden.

 

Ein Navigationskonzept berücksichtigt die Verlinkung der fragmentierten Inhalte, damit die Übersicht auch auf einem kleineren Bildschirm nicht verloren geht.

Schulung + Coaching

SCHEMA ST4 einführen

Ein Redaktionssystem ist nur so gut wie die Strukturen und Abläufe, in die es eingebettet wird. Daher ist eine methodische Einführung unerlässlich. Um das Effizienz- und Einsparungspotenzial eines Redaktionssystems voll auszuschöpfen, müssen die existierenden Informationsstrukturen und –prozesse mit dem einzuführenden System abgestimmt werden.

  

Auf Basis des Funktionsdesign-Ansatzes bieten wir Ihnen eine Abfolge aus Workshops und Trainings an. Während dieser Schulungen werden die Anwender schrittweise an das neue Redaktionssystem und die Arbeitsweise damit herangeführt. Typische Themen sind:

  • Sicherer und effizienter Umgang mit den Systemfunktionen, mit dem (XML-)Editor, der Inhaltsverwaltung und den Publikationsmechanismen
  • Standardisiertes Erfassen von Inhalten unter Berücksichtigung eines Redaktionsleitfadens
  • Die Einhaltung der Vorgaben des Datenmodells
  • Workflows und Freigabemechanismen
  • Die Zerlegung der Inhalte in Module (Topics)
  • Wiederverwendungsmöglichkeiten effektiv nutzen (Fragmente, Filter, Variablen, etc.)
  • Systembasierte Qualitätssicherung mit Schematron
  • Redaktions- und Übersetzungsprozesse
  • Besondere Funktionen nutzen (Callout Designer, Page Layout Designer, etc.)

 

Schulung + Coaching

In der Umsetzung sind verschiedene Formen denkbar und erprobt:

  • Wir bereiten die Schulungen vor, erstellen Schulungsunterlagen.
  • Wir können die Erstbefüllung des Systems übernehmen.
  • Wir erstellen die Musterdokumente.

Erfahrene Berater und Technikredakteure schulen vor Ort. Nach der Einführung stehen sie als Coaches zur Verfügung.