Grundsätze der Technischen Dokumentation

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

6 Gedanken zu „Grundsätze der Technischen Dokumentation

  • 13.11.2020 um 11:16
    Permalink

    Grundsätzlich sollten wir uns mehr den Unterschied zwischen Betreiberpflicht und Herstellerpflicht bewusst machen. Dann lassen sich die meisten Knoten schnell aus den Betriebsanleitungen entfernen.

    Antwort
  • 13.11.2020 um 11:24
    Permalink

    Guter Vorschlag. Dann lass uns das zusammen machen.

    Antwort
    • 16.11.2020 um 21:55
      Permalink

      Wie soll dies vonstatten gehen?

      Antwort
      • 17.11.2020 um 11:51
        Permalink

        Hallo Holger,

        aus meiner Sicht ist die Unterscheidung Hersteller / Betreiber / Anwender wichtig.
        Ich habe das schon häufiger wahrgenommen aber Maschinen und Anlagen sind nicht mein Schwerpunkt.
        Ich sehe zwar noch nicht, welche Knoten wir damit beseitigen, will das aber gerne mit Dir versuchen.
        Dazu können wir gerne mal zoomen und diskutieren.
        Wenn Du mir Input gibts oder wir unser Knowhow zusammenlegen, kann ich gerne die Formulierung übernehmen.
        Das können wir z.B. hier als Beitrag veröffentlichen.
        Dietrich
        PS Ich sehe es generell eine Schwäche unserer Innung, dass wir nicht genügend erarbeiten und schriftlich festhalten.
        Ein Vortrag bei der tekom ist leider nicht nachhaltig in diesem Sinne.

        Antwort
  • 14.11.2020 um 16:11
    Permalink

    Hallo Herr Juhl,
    wollten Sie „Technische Redakteure machen eine wichtige Arbeit“ in die Klammer hinter eine gegenteilige Behauptung setzen? Weil wenn nicht, dann würde ich hiermit gern widersprechen! 😉

    Antwort
    • 14.11.2020 um 16:22
      Permalink

      „Technische Redakteure machen eine wichtige Arbeit“. Nein, keine Einschränkung oder gegenteilige Behauptung.
      (Allerdings gebe ich zu, dass meine Statements etwas verwirrend sind, weil mal positiv ohne Widerspruch und mal negativ mit Widerspruch.)

      Antwort

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.