Technische Redaktion

Wenn Sie Engpässe bei der technischen Dokumentation haben, lassen Sie sich durch unsere erfahrenen Redakteure und Illustratoren professionell unterstützen. Hier erfahren Sie alles über unser Dienstleistungsangebot im Bereich der Technischen Redaktion:


Erstellen von Dokumentation

Wir erstellen oder überarbeiten für Sie die verschiedensten Dokumentarten:

  • Benutzerinformationen (Software-Dokumentation, kontextsensitive Online-Hilfen, Inbetriebnahmeanleitungen, Bedienungsanleitungen, Wartungsanleitungen, Datenblätter, Ersatzteilkataloge etc.)
  • Serviceunterlagen (Montageanleitungen, Reparaturanleitungen, Prüflisten, Diagnose-Hilfen etc.)
  • Interne technische Dokumentation (z. B. Dokumentation von Risikobeurteilungen)

 

Projektmodelle

Wie wir zusammenarbeiten, hängt ganz von Ihren Anforderungen ab. Folgende Projektmodelle einschließlich aller denkbaren Mischformen sind möglich:

  • Projektarbeit in unserem Büro
    Arbeitsweisen: Recherchebesuche in Ihrem Haus, Telefon-/E-Mail-Kommunikation, Datentransfer via Internet, Onlinesessions
  • Projektarbeit bei Ihnen vor Ort
    Arbeitsweisen: Arbeitsplatz mit Zugängen zu den benötigten Daten
  • Arbeitnehmerüberlassung
    Arbeitsweisen: wie interner Mitarbeiter

 

Tool-Umgebungen

Unsere Technischen Redakteure und Illustratoren verfügen über jahrelange Erfahrung in den verschiedensten Tools und Systemen.

Hier eine Auswahl:

  • Einsatz gängiger DTP-Programme: Adobe FrameMaker, Adobe InDesign, BroadVision QuickSilver/Interleaf, Microsoft Word, Macromedia RoboHelp
  • Redaktionssysteme: Author-it, Sirius von Acolada, Schema ST4, TCToolbox von Ovidius
  • Grafikprogramme: Adobe Illustrator, Adobe Photoshop, Corel Draw, Corel Designer, Corel Photo-Paint, Arbortext IsoDraw, Microsoft Visio
  • CAD-Programme: SolidWorks und SolidWorks Composer, Autodesk AutoCAD


Online-Medien

Von uns erstellte Dokumente werden typischerweise nicht nur gedruckt, sondern in verschiedenen Online-Medien zur Verfügung gestellt.

Beispiele dafür sind:

  • User Assistance, integrierte Software-Hilfe
  • Hilfe auf der Maschinensteuerung, über Touchscreen bedienbar
  • Verlinkte PDFs auf CD

 

Unsere Konzepte

In der technischen Dokumentation ist es immer das Ziel, möglichst schlank und kostengünstig zu arbeiten. Mit unserem ARAKonzept senken Sie die Erstellungs- und Übersetzungskosten Ihrer Dokumentation durch sowohl inhaltliche, strukturelle und textliche Optimierung als auch durch Optimierung der Prozesse. Und das Schöne an ARAKonzept: Gleichzeitig führen die Maßnahmen zur Kostensenkung zu Dokumenten, die klar verständlich und wirklich brauchbar sind!

Hiermit senken wir die Kosten:

  • Modularisieren der Dokumente, um die Erstellungs- und Übersetzungskosten durch Wiederverwendung von Komponenten zu minimieren. Die Modularisierung schafft außerdem die Basis für den Einsatz von Redaktionssystemen, die erst durch systematische Modularisierung ihr Potenzial voll entfalten können.
  • Standardisieren und Systematisieren des Textes und der Terminologie, um den Wiederverwendungsgrad zu erhöhen und einfache Übersetzbarkeit zu ermöglichen
  • Reduzieren des Textumfangs bei gleichbleibendem Inhalt, um den Pflegeaufwand und die Übersetzungskosten zu minimieren
  • Klares Vorgehensmodell, um Aufwände sehr einfach und genau abschätzen zu können und damit eine optimale Kostenkontrolle zu garantieren

Hiermit schaffen wir klar verständliche und brauchbare Dokumente:

  • Systematische Anwendung kognitionspsychologischer Grundlagen für Dokumente, die funktional, verständlich und für den Anwender nützlich sind
  • Strikte Topic-Orientierung für leicht erfassbare, überschaubare Informationseinheiten, die modulares Schreiben ermöglichen und Single-Source-Publishing unterstützen
  • Genaue Zielgruppenausrichtung, Standardisieren und Systematisieren von Text und Terminologie als Mittel zur Reduzierung des Textumfangs  häufig um 30% und mehr
  • Durchdachtes Navigations- und Verlinkungskonzept, das es dem Anwender erlaubt, Antworten auf seine Fragen von jeder beliebigen Stelle aus zu finden

 

Unsere Qualifikation

Unsere technischen Redakteure sind in unseren Konzepten ausgebildet und projekterfahren. Alle haben neben ihrer Ausbildung zum technischen Redakteur einen technischen oder naturwissenschaftlichen Ursprungsberuf und können sich daher schnell in Ihren speziellen Themenbereich einarbeiten.

  • Fachgebiete der Ursprungsberufe unserer Redakteure: Maschinenbau, Elektrotechnik, Informatik, Wirtschaftsinformatik, Medieninformatik, Physik, Chemie, Pharmakologie, Architektur
  • Interne Ausbildung unserer Redakteure: ARAKonzept als Basisschulung

Technische Illustration

Passend zu Ihren Dokumenten erstellen oder überarbeiten wir für Sie:

  • 2D/3D-Darstellungen als Strichzeichnung
  • 2D/3D-Darstellungen aus CAD-Daten
  • Bewegte Grafiken (Animationen) aus CAD-Daten
  • Explosionszeichnungen
  • Bearbeitete Fotos
  • Schemata, Diagramme (z. B. normgerechte Flussdiagramme)
  • Darstellungen von Benutzeroberflächen

Unsere Illustratoren arbeiten eng mit den Redakteuren zusammen, um einen klaren Text-Bild-Bezug herzustellen.

Erarbeiten eines Dokumentationskonzepts

Für eine effiziente Arbeit in der Redaktion und Dokumente, die anwenderfreundlich sind und den gesetzlichen Anforderungen entsprechen, benötigen Sie ein Dokumentationskonzept.

Wir erarbeiten mit Ihnen zusammen ein Konzept für Ihre technische Dokumentation:

  • Analyse der benötigten Dokumente
  • Erarbeitung eines Struktur- und Inhaltskonzepts für die Dokumente
  • Berücksichtigung von gesetzlichen Anforderungen und Normen (VDI 4500, IEC 82079-1, produktspezifische Anforderungen, Maschinenrichtlinie)
  • Dokumentation des Konzepts in einem Redaktionshandbuch
  • Umsetzung des Konzepts an Musterdokumenten
  • Erstellung von Vorlagen

Management von Dokumentationsprojekten

Wir sind Spezialisten für komplexe technische Dokumentation auf allen Medien und erfahren in der Abwicklung auch großer Projekte.

Im Bereich Projektmanagement bieten wir Ihnen:

  • Management vollständiger Dokumentationsprojekte einschließlich der kompletten Übersetzung
  • Klares Vorgehensmodell für das Dokumentations- und Übersetzungsprojekt, um Aufwände sehr einfach und genau abschätzen zu können und damit eine optimale Kostenkontrolle zu garantieren

Normenanalyse

Um sicherzustellen, dass Ihre Dokumente den gesetzlichen Anforderungen entsprechen, ist es erforderlich, Normen und Richtlinien zu beachten.

Auf diesem Gebiet bieten wir Ihnen folgende Unterstützung an:

  • Analyse der für Ihr Produkt gültigen Normen und Richtlinien im Hinblick auf Anforderungen an die technische Dokumentation
  • Bericht über die Anforderungen mit Empfehlungen, wie diese in der Dokumentation umgesetzt werden sollten

Darstellungsbeispiele

Hier sehen Sie eine kleine Auswahl von Beispielseiten, die den von uns hergestellten Betriebsanleitungen entnommen sind:

Bedienungsanleitung für Maschinenbau

Beschreibung von Sicherheitseinrichtungen

Anleitung in einer Bedienungsanleitung