Beratung

Beratung

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.

 

Dokumentanalyse

Schwachstellen präzise benennen

Ihre Dokumente werden von uns auf klassifizierbare Schwachstellen untersucht:

  • Verständlichkeit von Text und Bild
  • 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 rechtliche Anforderungen >

 

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.

Funktionsdesign

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. 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.

 

Grundlage hierfür kann der Dokuwerk eigene Redaktionsleitfaden sein. Der Leitfaden berücksichtigt zudem tekom Richtlinien und wird auf Ihre Anforderungen hin angepasst. 

 

Redaktionsleitfaden

Das Nachschlagewerk für Ihre Redaktionsarbeit 

Den Kern eines Redaktionsleitfadens (RLF) bilden die Regeln zur Textstandardisierung, basierend auf der Methode Funktionsdesign. Der RLF ist ein zentrales Instrument, effiziente Arbeitsweisen einzuführen und Kosten zu reduzieren. Warum? Weil neben den allgemein gültigen Schreibregeln auch spezifische Anforderungen für die Erstellung Ihrer Dokumente festgehalten werden. Ein umfassender Redaktionsleitfaden beschreibt die Arbeit der Redaktionsabteilung und bietet damit folgenden Nutzen:

 

  • Vorgaben und Prozesse werden erklärt und mit Beispielen versehen.
  • Redakteure werden an die strukturierte Arbeit herangeführt.
  • Neue Mitarbeiter werden bei der Einarbeitung unterstützt.
  • Qualitätsmaßstäbe der Redaktion werden transparent gemacht.

Der RLF bei Einsatz eines Redaktionssystems

Kommt ein Redaktionssystem zum Einsatz, wird auch die Konfiguration des Systems im Redaktionsleitfaden beschrieben:

 

  • der Aufbau und die Struktur der Datenablage
  • die Nutzung des Editors
  • die Struktur des verwendeten Datenmodells und die konkrete Nutzung auf Basis des Funktionsdesign

Zunehmende Bedeutung bekommt die Verwendung der Metadaten

Metadaten und Taxonomien („vererbbare Metadaten")  ermöglichen das Filtern von Inhalten bei der Produktion oder unterstützen Suchmechanismen in einem Content Delivery Portal. Ein sinnvolles Konzept für Ihre Metadaten nehmen wir gern in die Hand und halten die wichtigsten Punkte dazu im RLF fest.

 

Als sinnvolle oder sogar notwendige Ergänzung zum Redaktionsleitfaden empfehlen wir einen Grafikleitfaden.

Grafikleitfaden

Der Grafikleitfaden ist das Pendant zum Redaktionsleitfaden oder häufig ein Bestandteil des Redaktionsleitfadens. Er unterstützt die Bild- und Grafikproduktion, führt zu einem einheitlichen Erscheinungsbild und stützt die Wiederverwendung von Grafiken.

Standardisierte Grafikproduktion

Mit der Einführung eines Redaktionssystems werden für Textinhalte in der Regel Standards entworfen. Der Grafikleitfaden ist das Pendant dazu.  

 

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 und rechtliche Anforderungen

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. Nach gesetzlichen Vorgaben müssen Betriebsanleitungen, Gebrauchsanweisungen, Einbauanleitungen etc. 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

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, über Taxonomien gefilterte Inhalte, etc.

 

Sollen Anleitungen auf kleinen Bildschirmen wie Smartphones sinnvoll dargestellt werden, müssen die Anforderungen noch genauer gefasst werden:

 

  • Längere Handlungssequenzen müssen in Einzelschritte zerlegt werden.
  • die beliebte Zusammenfassung von Daten in umfangreichen Tabellen muss auf Machbarkeit geprüft und Alternativen angedacht werden.
  • Grafiken müssen skalierbar erstellt werden.
  • Das Navigationskonzept muss die Verlinkung der fragmentierten Inhalte berücksichtigen, damit die Übersicht auch auf einem kleineren Bildschirm nicht verloren geht.

 

Für mehr Informationen zum Thema Modularisierungskonzept rufen Sie uns einfach an. Wir freuen uns auf Sie!