Technische Dokumentation | Projektleitung | Software-Entwicklung | SW-Tools | Schulungen | Gefährdungsanalyse
Startseite
Produkte
TippyTerm
Shop
Über uns
Partner
Referenzen
Presse
Kontakt
Impressum
Technische Dokumentation

Unser Spezialgebiet ist die Planung und Erstellung von technischer Dokumentation.

Die Dokumentation begleitet den gesamten Lebenszyklus eines Produktes. Sie beginnt mit dem Entwurf des Produktes und wird dann weiter entwickelt mit Pflichten- und Lastenheften oder Spezifikationen.

Die eigentliche Anlagen- oder Produktdokumentation beinhaltet im Allgemeinen die Unterlagen zum Betrieb, zur Bedienung, zur Wartung und Instandhaltung.

Weitere Optionen sind z.B. separate Inbetriebnahmedokumentationen, Schulungsunterlagen, Dokumentations-Upgrades und Dokumentationen für Anlagen-Retrofits.

Am Ende des Lebenszyklus eines Produktes stehen die Verfahrensbeschreibungen zu dessen Entsorgung und Verschrottung.

 
Planung und Erstellung

Realistische Planung des Dokumentationskonzepts entscheidet über Erfolg und Rentabilität des gesamten Erstellungsprozesses für die Kundendokumentation.
Dies beinhaltet die Entwicklung von Konzepten für:

  • Erstellung der Dokumentation, gemeinsam mit Produktmanagement und ggf. Entwicklungsleitung
  • Datenorganisation und Definiton des Übersetzungsprozesses
  • Recherche komplexer Sachverhalte und zielgruppenorientierte Darstellung in Wort und Bild
  • Übernahme bzw. Neuerstellung von Grafiken, Fotos und Konstruktionsunterlagen
  • Eventuell notwendige Übernahme von Fremddokumentationen
  • (sog. OEM-Dokumentationen)


Ausgabemedien

Wurde bis vor wenigen Jahren Dokumentation nur als Papier ausgeliefert, so wird sie heute immer mehr als multimediales Produkt verstanden, dessen Inhalte auf unterschiedlichen Wegen vermittelt werden.
Wichtigstes Medium ist nach wie vor der Papierausdruck, die dazu layout-identische PDF-Version auf Datenträger/PC/Internet wird jedoch immer wichtiger.
Durch intelligente Verlinkungen zwischen und in den PDF-Dateien werden die Inhalte im elektronischen Zugriff leichter zugänglich.
Ein lokales Web (für Bedienoberflächen auch als integriertes Hilfesystem zu nutzen) erlaubt es, solche Verlinkungen zu optimieren.
Dokumentationen von Unterlieferanten werden häufig in Form von XML-Zwischenformaten geliefert und finden beim Systemlieferanten ihr visuelles Layout.

 

© SysKon GmbH