Grundsätze der Technischen Dokumentation

BB_0014_Standpunkte

Aus meiner Sicht gibt es bei uns und in der Welt ein paar Vorurteile, die unser Selbstverständnis und unsere Arbeit verunsichern.


Deswegen empfinde ich es als wichtig, dass wir ein paar Grundsätze feststellen und gemeinsam verabschieden.

Grundsätze und Vorurteile, hier bunt gemischt, sind z.B.:

  • Anleitungen sind wichtig und nutzen
  • Anleitungen werden nicht gelesen (stimmt manchmal aber nicht immer)
  • es gibt keine guten Anleitungen (das stimmt natürlich nicht)
  • Anleitungen sind überflüssig (es gibt ein paar wenige Konstellationen bei denen das stimmt)
  • elektronische Anleitungen sind nicht erlaubt (stimmt nicht. Richtig ist: Elektronische Dokumentation ist erlaubt, aber es gibt Ausnahmen).
  • Technische Dokumentation dient zur Absicherung des Herstellers (stimmt nicht: TD ist wichtig Information für die Anwender und dient auch der Absicherung des Herstellers)
  • Technische Redakteure machen eine wichtige Arbeit
  • es sollte besser vor allen Gefahren gewarnt werden (stimmt nicht, wir müssen uns über eine sinnvolle Grenze einigen)
  • Warnhinweise müssen groß und im Kasten sein (stimmt schon lange nicht mehr)

Sicher gibt es noch mehr und sicher können wir die Formulierungen diskutieren. Mir wäre es wichtig, dass wir uns einigen und solche Grundsätze festschreiben.

Haben Sie Lust zu einer oder mehreren Video-Sitzungen dazu, dann schreiben Sie mir bitte.

Auch Ihre Kommentare sind willkommen.

Dietrich Juhl

die letzten Posts

Doku-Abteilung aufbauen

In vielen Unternehmen wird die Technische Dokumentation noch nebenbei von Entwicklern, Produktmanagern oder anderen erledigt.Wenn dann ein Technischer Redakteur eingestellt

Typologie der TD

Wer sich mit der Technischen Dokumentation (TD) als Ganzes beschäftigt, stellt fest, dass es eine große Bandbreite an Produkten und

Betreiber als Zielgruppe?

Im Maschinenbau schreiben wir (Technischen Redakteure) Betriebsanleitungen für die Anwender und den Betreiber meistens undifferenziert für beide. Ich frage mich.