Interne Technische Dokumentation

Arbeitsanweisungen und SOPs, Qualitätsaufzeichnungen, Pflichtenhefte, Wissensdatenbanken und Leitfäden haben eins gemeinsam: Nur anforderungsgerechte und wirksam verwendete Informationen führen zu effizienten Prozessen.

Interne Technische Dokumentation – was ist das?

Das Zwiebelmodell der Technischen Kommunikation zeigt, wie im Produktlebenszyklus externe Dokumentation – Anleitungen, Kataloge, Webseiten – aus der internen Dokumentation entsteht.

Zur internen technischen Dokumentation gehören beispielsweise Entwicklungsdokumente wie die Risikobeurteilung, QM-Dokumente wie Arbeitsanweisungen und Leitfäden, oder Qualitätsaufzeichnungen wie Prüfchecklisten und Log-Files.

Eine geeignete interne Dokumentation ist Grundvoraussetzung, um eine externe Dokumentation zugleich anforderungsgerecht und effizient zu entwickeln.

Dabei sind die Regeln und Prinzipien für interne Dokumentation ähnlich wie für die externe Dokumentation: Informationen müssen leicht zugreifbar, aktuell und korrekt, strukturiert, verständlich, minimalistisch und anwendbar sein.

 

arrow down

Redaktionsleitfaden

Ohne die schriftlichen Regeln eines lebenden Redaktionsleitfadens geht die Qualität baden. Der Redaktionsleitfaden ist Basis für Schulung und Qualitätssicherung und dient als Nachschlagewerk für die alltägliche Arbeit. Aber nicht nur: Ein Redaktionsleitfaden ist das Wissensmanagement einer Technischen Redaktion!

Technische Redaktionen professionalisieren sich immer stärker und schaffen spezialisierte Rollen für die zunehmenden Aufgaben:

  • Produkt- und Zielgruppenrecherche, Normen- und Anforderungsmanagement
  • Struktur von Informationsprodukten (Dokumentarten) und Informationsarten für verschiedene Produktbereiche
  • Formulierung und Syntax
  • Terminologiemanagement
  • Illustration und Medienproduktion
  • Modularisierung, Klassifikation und Metadaten
  • Qualitätssicherung, Reviews, Lektorate
  • Übersetzungsmanagement
  • Erstellen von Warnschildern oder Software-Texten
  • und vieles mehr

In gleichem Maße nimmt auch der Regelungsbedarf zu.

Redaktionsleitfäden können als Wiki oder in den Redaktionssystemen selbst erstellt und gepflegt werden. Mit klaren Verantwortungen und Regeln sind sie tagesaktuell: Besprechungsergebnisse müssen nicht in Protokollen zwischengelagert werden, sondern stehen der Redaktion zeitnah zur Verfügung. Nur wenn die Regeln aktuell sind, schafft der Redaktionsleitfaden die nötige Belastbarkeit.

Was wir tun

Wir entwickeln gemeinsam mit der Redaktion Standards, die sich an den tatsächlichen Arbeitsprozessen der Technischen Redaktion orientieren und die Arbeit optimal unterstützen. Dabei nutzen wir auch unsere Methode Funktionsdesign.

Dabei erfinden wir das Rad nicht neu: Viele bewährte Regel-Bausteine aus über 80 bestehenden Leitfäden können mit den nötigen Anpassungen genutzt werden.

arrow down

Leitfaden für Verwaltungen im Case Management

Große Verwaltungen müssen oft tausende von Kundenkorrespondenzen bedienen. Doch welcher Textbaustein ist für welchen Fall der richtige? Und liegt hier nicht ein Sonderfall vor, der neu formuliert werden muss?

Für einen Leitfaden im Case Mangement steht die effektive Unterstützung der Personen im Vordergrund, die mit dem Leitfaden arbeiten müssen: Ihre Aufgaben und Arbeitsweisen müssen genau geprüft und verstanden werden.

Wissensdatenbanken, Anforderungen oder Qualitätsaufzeichnungen werden oft von vielen verschiedenen Autor:innen erstellt oder bearbeitet. Um die erforderliche Durchgängigkeit und Wirksamkeit zu erreichen, braucht es klare Standards und Arbeitsmittel:

  • Klare Benennungen, klare Terminologie
  • Standardisierte Strukturen – am Arbeitsprozess und am Informationsbedarf orientiert
  • Funktionale Formulierungsmuster
  • Vorlagen und Textbeispiele

Was wir tun

Wir entwickeln in enger Zusammenarbeit mit den Prozessverantwortlichen anforderungsgerechte Strukturen für die interne Dokumentation. Wir legen Schreibregeln fest, formulieren Beispiele. Wir definieren einen Terminologieprozess und einen Basis-Wortschatz. Wir schulen die Autor:innen der internen Regelwerke und Leitfäden und entwickeln einen geeigneten Erstellungs- und Freigabeprozess.

Bei Bedarf führen wir ein auf die Anforderungen passendes und geeignetes Autorensystem ein.

arrow down

Arbeitsanweisungen

Die Qualität von Arbeitsanweisungen wirkt sich unmittelbar auf die Produktivität und Effektivität eines Unternehmens aus. Sei es in einer Produktion, einem Labor oder für einen Außendienst.

Arbeitsanweisungen müssen aktuell, klar und verständlich, deutlich und sicher sein. In den Qualitätsanforderungen ähneln sie daher den Anleitungen zu Produkten. Sicherheitsaspekte, auf den Arbeitsplatz bezogene Arbeitsschritte, Fokussierung auf die in der Praxis wesentlichen Informationen („Minimalismus“), eindeutige Terminologie und klare Text-Bild-Bezüge, aber auch die Einhaltung standardisierter Strukturen sind wichtige Anforderungen für Arbeitsanweisungen.

Was wir tun

Ausgehend von bestehenden Standards schaffen wir klare Regeln und Strukturen für die Arbeitsanweisungen. Ein Redaktionsleitfaden regelt, wie Arbeitsanweisungen formuliert, erstellt, illustriert und verteilt werden.

Alle Autor:innen werden für die Arbeit mit dem Leitfaden geschult.

arrow down