Diskussion:Technische Dokumentation

Artikel überarbeitet im Februar 07

So, ich war so frei und habe den Artikel umfassend überarbeitet, wobei ich nicht den Anspruch auf Vollständigkeit erhebe ;-). Meine Gründe für die Überarbeitung habe ich unten dargelegt; meines Erachtens hat die vorige Version den Begriff der Technischen Dokumentation viel zu eng gefasst (bitte nicht persönlich nehmen). Ansonsten würde ich mich über weitere Redigierungen sehr freuen. Und falls noch jemand stilistisch bügeln kann: gerne, nur zu ;-) Gruß + gutes Gelingen --Seiduselbst 21:32, 1. Feb. 2007 (CET)

Der erste Abschnitt ist falsch

Hallo,

der erste Abschnitt ist falsch, weil dort unter Technischer Dokumentation nur die so genannte Externe Dokumentation erfasst wird, nicht die Interne. Das widerspricht auch den nachfolgenden Abschnitten.

Gruß

Ulrich Thiele --Uthi 23:46, 3. Jun 2006 (CEST)

Ich denke ebenfalls, dass der Begriff "Technische Dokumentation" hier zu eng gefasst ist. Der Autor beschreibt im Wesentlichen die Benutzerinformation, die in der Tat vom Technischen Redakteur erstellt wird.

Imho ist "Technische Dokumentation" in erster Linie die Gesamtheit der Technischen Unterlagen, die zum Zweck der Dokumentation eines technischen Produktes aufbereitet und dauerhaft archiviert werden. Neben der Information einer bestimmten Zielgruppe ist der eigentliche Grund der Technischen Dokumentation die rechtliche Absicherung des Herstellers und die Rückverfolgbarkeit des Produktionsprozesses. Die interne und externe Benutzerinformation, die der Autor hier beschreibt, bildet letztlich nur die Essenz aus dieser Dokumentation.

Beispiel: Gemäß der EG-Maschinenrichtlinie ist der Hersteller verpflichtet, eine Technische Dokumentation zu erstellen. Diese enthält alle Unterlagen, die notwendig sind, im Bedarfsfall die Konformität der Maschine mit den Zielen der Richtlinie nachzuweisen. Dazu gehören z.B. Detailzeichnungen, Berechnungen, Versuchsergebnisse und Risikobeurteilungen.

Mit der Erstellung dieser Unterlagen sollte der Technische Redakteur tunlichst nichts zu tun haben, da sie eher eine Arbeitsgrundlage für seine Tätigkeit sind: nämlich die Erstellung von extenen und internen Benutzerinformationen.

Aus eigener beruflicher Praxis heraus scheint es mir geboten, diese Begriffsdefinition klar zu formulieren. Meine Erfahrung ist, dass infolge der Unschärfe des Begriffes in vielen Betrieben reflexartig die Verantwortung auf den Technischen Redaktuer abgeschoben wird, wenn es um "Technische Dokumenation" geht. Die Erstellung bzw. Aufbereitung der Dokumentation setzt aber viel früher an. Sie ist bereits Teil des Entwicklungs- und Produktionsprozesses, was am Beispiel der Risikobeurteilung deutlich wird.

Soweit meine Meinung. Gruß und gutes Gelingen --Seiduselbst 09:37, 31. Jan. 2007 (CET)

Falls noch nicht bekannt, Wikipedia ist eine freie Enzyklopädie, an der jeder mitarbeiten kann. Warum also Arbeitsanweisungen hinterlassen, statt selbst an dem Artikel rumzubasteln? ;o) Gruß, --Flingeflung 11:03, 31. Jan. 2007 (CET)

Weil nicht jeder ein so verwegener Haudegen ist wie Du ;-). Aber Spaß beiseite. Der Autor hat sich bei der Definition des Begriffes offensichtlich an die VDI4500 gehalten. Das ist soweit ja in Ordnung. Trotzdem sehe ich aus den o.a. Gründen einen gewissen Handlungsbedarf und würde mir eine sachliche Diskussion wünschen, bevor der Artikel wild editiert wird. Ich warte mal noch etwas ab. Aber wenn ich loslege, dann richtig ;-). So long --Seiduselbst 12:54, 31. Jan. 2007 (CET)

Danke für das (unnötige und ungerechtfertigte) Kompliment. Aber Spaß beiseite. Es scheint nun mal so zu sein, dass diejenigen Leute, die was fachlich Fundiertes zu diesem Thema beizutragen haben, beruflich zu eingespannt sind, um hier aktiv zu werden, und sich lieber auf der Nehmer- statt auf der Geberseite befinden. Wenn dein Wissen also fundiert ist, spricht nichts dagegen, es zu publizieren und DANN darüber zu diskutieren. Worüber soll man denn sonst diskutieren? Dass was getan werden muss? Das macht schon die Politik, wir sind doch eher Praktiker, oder? Ich schlage also vor, du legst mal so richtig los ;-) Gruß, --Flingeflung 14:33, 31. Jan. 2007 (CET)

OK, überredet. Werde mich aber gleich mal dransetzen. cu --Seiduselbst 15:20, 31. Jan. 2007 (CET)

Normen sind freiwillig!

ich würde den Abschnitt 'Normen' gerne um diesen Absatz ergänzen:

Der Einsatz von Normen ist auch hier vom Gesetzgeber nicht vorgeschrieben und somit grundsätzlich freiwillig. Die Maschinenrichtlinie beispielsweise fordert allerding das Arbeiten auf dem Stand der Technik, was sich auch auf das Erstllen der Technischen Dokumentation bezieht. Da Norem anerkannterweise den Stand der Technik representieren ist es in der Praxis kaum möglich diesem Anspruch gerecht zu werde nohne mit aktuellen Normen zu arbeiten. (nicht signierter Beitrag von Antrophonix (Diskussion | Beiträge) 12:58, 23. Mai 2010 (CEST))

Vorwärtsdokumentation

Was soll das sein? Ich habe den Begriff noch nie gehört. Gibt es auch eine Rückwärtsdokumentation? Laut Google scheint der Begriff nicht sonderlich verbreitet zu sein: 105 Fundstellen, davon auf den ersten Blick die Hälfte PDFs, was mehr auf Eigengewächse denn auf offizielle Begriffsdefinition schließen lässt. Gruß von Flingeflung 16:46, 6. Dez. 2006 (CET)

Da sich seit 2 Monaten niemand gemeldet hat, scheint sonst niemand den Begriff zu kennen. Ich werde ihn nun entfernen. Gruß --Flingeflung 10:59, 31. Jan. 2007 (CET)

Rückwärtsdokumentation

Ja es gibt den Begriff der Rückwärtsdokumentation im Bereich der Steuerungssoftware. Im Rahmen der Rückwärtsdokumentation nimmt man den existierenden u. einem fremden Steuerungsprogrammcode und dokumentiert seine Arbeits-/Funktionsweise in der Dokumentation. Dabei greift man teilweise auf existierende Programmwerkzeuge zu, die diese Arbeit unterstützen. Gruß --Andreas 14:16, 30.11.2010 (CET) (ohne Benutzername signierter Beitrag von 129.230.56.12 (Diskussion) )

Erweiterungen und Abgrenzung vom Artikel Technischer Redakteur

Der Artikel hat naturgemäß viele inhaltliche Überschneidungen mit dem Artikel Technischer Redakteur. Dort sind auch einige Literaturhinweise und Weblinks zu Universitäten zu finden. Um den Artikel Technische Redaktion weiter zu fundieren, habe ich allgemeine Literaturhinweise und mehrere Links zu Themen-Blogs hinzugefügt. Nach meiner Auffassung besteht aber auch inhaltlich noch Erweiterungsbedarf: Werde zeitnah Ergänzungen zu Terminologie, Dokumentationssystematik und Zielgruppenanalyse beisteuern. Das sollte helfen, um einen Fokus auf die Aufgaben und Vorgehensweise in der Technischen Redaktion zu setzen, während der Artikel Technischer Redakteur sich eher mit dem Berufsbild und Ausbildungsmöglichkeiten beschäftigt. Gibt es noch weitere Vorschläge und Ideen? --Sympathisant (Diskussion) 14:32, 27. Aug. 2012 (CEST)

Technikdokumentation und Produktdokumentation

Warum werden o.g. Begriffe die „auch- und oder-Begriffe“ sind, nicht weitergel., was in der WP sonst üblich ist? -- 217.224.230.182 20:52, 28. Jan. 2015 (CET)

Wohin sollen sie denn Deiner Meinung nach weitergeleitet werden? --Flingeflung (Diskussion) 08:23, 29. Jan. 2015 (CET)

Neuere Normen erwähnen ... Zweck der TD

Normenreihe zur Software-Dokumentation erwähnen: Die ISO hat einen neuen Standard veröffentlicht, der sich mit Softwaredokumentationen befasst. Sowohl gedruckte als auch elektronische Dokumentationen werden berücksichtigt: ISO/IEC 26511 bis 26514.

Dokumentation dient *nicht* der haftungsrechtlichen Absicherung eines Herstellers! Da wird Ziel und Mittel miteinander verwechselt. Dokumentation soll den Benutzer dazu anleiten, ein Produkt zumindest sicher zu bedienen. Wenn Schäden an Leib, Leben oder Sachen entstehen, dann kann u.U. der Hersteller oder Vertreiber des Produkts über Produkthaftungsgesetz oder Vertragsrecht belangt werden. Die TD dient auch nicht der Produktbeobachtung. Sondern Erkenntnisse aus der Produktbeobachtung müssen in die TD einfließen.

Die Unterscheidung zwischen interner und externer Dokumentation ist m.E. weniger relevant wie die Zielgruppenspezifik. Zur internen Dokumentation gehört dann auch alles an Dokumentation aus dem Bereich Projektmanagement. Bei Medizinprodukten müssen auch alle Entscheidungen und Prozesse daraus aufbewahrt und vorgelegt werden.

Ein technischer Redakteur ist kein Übersetzer. Ein technischer Redakteur plant Dokumentationsprozesse, konzipiert TD, verwaltet sie, steuert alle damit verbundenen Prozesse. In kleineren Unternehmen schreibt er das alles auch, in größeren können externe Dienstleister hinzutreten.

Struktur: DITA, DocBook, S1000D, usw usf. Information Mapping und Funktionsdesign sind Hilfsmittel auf Topic- und Satzebene zur Strukturierung. Farben und Konstraste in Sicherheitshinweisen sind nicht aus sich selbst heraus wesensbildende Bestandteile der TD.

Verwendung von Farben und Kontrasten in Sicherheitshinweisen

Ich beziehe mich auf den Text: "Die Europäische Norm EN ISO 12100-2 regt die Verwendung von Farbe in folgendem Sinne an: „Die Verwendung von Farbe sollte in Erwägung gezogen werden, insbesondere bei Bauteilen, die schnelles Erkennen erfordern.“"

Diese Norm bzw. der Abschnitt -2 wurde zurückgezogen und ersetzt durch DIN EN ISO 12100:2011-03, daher bitte aktualisieren.

Der Punkt e):"Die Verwendung von Farben sollte in Erwägung gezogen werden, besonders bei Bauteilen, die schnelles Erkennen erfordern." bezieht sich nicht auf Sicherheitshinweise direkt, sondern auf Grafiken oder Zeichnungen oder auch Fotos. Dort sollen möglichst diejenigen Teile farbig hervorgehoben werden, in denen man Gefährdungspotenzial sieht.

Besser passend wäre also hier der Hinweis auf Punkt a): "Art und Größe der Schrift müssen bestmögliche Lesbarkeit sicherstellen. Sicherheits- und/oder Warnhinweise sollten durch Farben, Symbole und/oder große Darstellung hervorgehoben werden."

Extrem veraltete Definition > Überarbeitung dringend notwendig

Die Definition "Eine Technische Dokumentation (auch Technikdokumentation oder Produktdokumentation) umfasst alle Informationsprodukte, die ein technisches Erzeugnis beschreiben und zu seiner Nutzung, Wartung oder Reparatur anleiten. Sie bereitet die Informationen systematisch auf und strukturiert sie so, dass der jeweilige Zweck vollständig erfüllt wird. Die Technische Dokumentation wird dem dokumentierten Erzeugnis meist über Namens- und Nummernsysteme eindeutig zugeordnet." ist veraltet und schließt alle Software-Dokumentationen aus. Weiteres Manko: Quellennachweis fehlt. "jeweiliger Zweck": unklarer Term. Ist damit gemeint, dass die abgeschlossene Strukturierung einer firmeninternen Klassifikation vollständig entspricht? Techikdokumentation oder Produktdokumentation gelten als nicht zulässige Terme.

Die Tekom e.V. als maßgeblicher Fachverband hat im TermXplorer folgende Definition festgelegt: "Gesamtheit aller notwendigen und zweckdienlichen Informationen über ein Produkt und seine Verwendung, die in strukturierter Form – sei es auf Papier oder als elektronische Medien – festgehalten sind."

Aus welchem Grund die Zuordnung über Systematiken ein fundamentales Kennzeichen einer TD ist, erschließt sich mir nicht. Definitionen aus einschlägiger Norm 62079-1:2021-9 müssen eingearbeitet werden.

Rechtliche Situation in Deutschland und anderen Ländern

Zur Zeit ist nur unzureichend dargestellt, inwieweit die rechtliche Situation für Deutschland zutrifft, für die EU generell und für sonstige Länder. Bitte dahingehend ändern, so dass klar ist, für welche Länder rechtliche Situaion gilt. Danke! --Christoph Demmer (Diskussion) 09:21, 8. Mär. 2023 (CET)