Konzepte

Dokumentationskonzept und Redaktionsleitfaden

Keine Dokumentation ohne ein durchdachtes und abgestimmtes Konzept!
Dabei gilt es nicht nur, das Corporate Identity zu berücksichtigen.

Eine gute und wirtschaftliche Technische Dokumentation entsteht nach einem Konzept das sich mit allen anderen Firmendokumentationen im Einklang befindet. Sie
- präsentiert sich verständlich, übersichtlich und lernlogisch
- muss auf das Zielpublikum zugeschnitten sein
- betrifft ein bestimmtes Produkt, keine Typenreihe oder Produkteserie
- erfüllt sämtliche fachlichen und produkthaftrechtlichen Auflagen
- berücksichtigt die Möglichkeiten zeitgemässer Kommunikationstechnik
- soll kostenoptimal sein
- ist aktuell bei Auslieferung; letzte Änderungen fliessen unmittelbar vor Publizieren noch ein
  (
Gedrucktes erscheint in der erforderlichen Menge «just in Time». Kein teures und veraltetes
  Drucksachenlager mehr)

- spielt eine werbeunterstützende Rolle  

Der Redaktionsleitfaden ist dabei das firmeneigene, möglichst in eigener Regie oder Anleitung erstellte "Gesetz- und Qualitätshandbuch" für die Technische Dokumentation. Für Global operierende Unternehmen führt daran keinen Weg vorbei, ausser Sie sind gewillt, Termine zu verpassen, Mitarbeiter zu verärgern, Pönalen zu missachten und viel Geld zu verlieren.


























Qualität macht sich bezahlt!
Der Redaktionsleitfaden enthält sämtliche Prozesse, Vorschriften, Normen, Software-Einstellungen, Hinweise, Hilfen, Parametrierungen,  Angaben zu Syntax, Grammatik, Abkürzungen, Sonderzeichen, Tabellen, verbotene und gültige Grafikformate, Konvertierungen, Korrekturlesungen, Speicherorte, Qualitätssicherung, usw. um eine wirtschaftliche Dokumentationserstellung zu ermöglichen.

Er sichert die Qualität und vereinfacht die Einarbeitung von neuen Mitarbeitern.

Wie sieht einheitliche Produktedokumentation überhaupt aus? Da gibt es meistens technische Dokumentationen, aber auch kommerzielle Prospekte, Leaflets, Handouts etc. Auch veröffentlichte Fachartikel gehören dazu. Im weiteren gibt es ökonomische und gesetzliche Fragen die man gut, weniger gut und schlecht angehen kann:

- einheitliches CI (Corporate Identity)
- einheitliches Vorgehen bei Terminologiemanagement und Fremdsprachen
- dokumenttypische Struktur
- berücksichtigung von Normen, Vorschriften und Leitfäden
- und so weiter


Unsere Spezialität: Sondermaschinenbau, Softwarebeschreibungen