Was ist eigentlich Technische Dokumentation?

Was ist Technische Dokumentation?Ist Ihnen der Begriff Technische Dokumentation bekannt? Falls ja, dann haben Sie diesen bestimmt schon jemandem erklären wollen, nur um dann bei „Wo fange ich jetzt eigentlich an?“ oder „Das hat was mit Bedienungsanleitungen zu tun.“ stehenzubleiben.

Vielleicht kann man den Begriff am einfachsten durch einen typischen Entstehungsprozess erklären, also von den Gedanken zur Zielgruppe über die Nutzersituation bis zur Form der Dokumentation. Weiterlesen

Überblick: Mobile Dokumentation

Überblick mobile DokumentationMobile Dokumentation scheint ja langsam im Mainstream anzukommen. Jedenfalls war die Frage, wie man Dokumentation auf Smartphones oder Maschinendisplays bekommt, immer wieder Thema bei uns auf der tekom Frühjahrstagung. Doch was verbirgt sich eigentlich hinter dem Schlagwort „mobile Dokumentation“? In diesem Post wollen wir uns die verschiedenen Varianten einmal genauer ansehen. Weiterlesen

Nachwuchspreis „Berufliche Kommunikation“ 2019

Nachwuchspreis Berufliche Kommunikation 2019, doctima, GALKommunikation ist ein wichtiger Bestandteil unseres Arbeitsalltags: Präsentationen erstellen, E-Mail-Support leisten, Entwicklungsgespräche führen, Unterrichtsgespräche gestalten, Fachliches an Laien vermitteln etc. Doch obwohl berufliche Kommunikation im Arbeitsalltag eine wichtige Rolle spielt, sind bisher nur vereinzelte Aspekte der beruflichen Kommunikation erforscht. Und selbst wenn wissenschaftliche Erkenntnisse vorliegen, mangelt es doch oft an der Übertragung in die Praxis. Das wollen wir ändern! Weiterlesen

Brexitfolgen: Neue Dokumentationsrichtlinie der EU

Der Brexit und seine Folgen für die Technische DokumentationAuch wenn uns der ganze Brexit wie ein Aprilscherz vorkommt, aber gar keiner ist: Diese Meldung ist natürlich dem Datum geschuldet, aber wer weiß, was da noch auf uns zukommt… 

Die EU-Kommisssion warnt Technische Redaktionen vor den Konsequenzen eines harten Brexit. Bei einem ungeregelten Austritt kämen demnach erschwerte Anforderungen auf die Hersteller von Produkten zu. Weiterlesen

Vienna Calling – Rückblick auf die tekom F19

Rückblick tekom Frühjahrstagung 2019 in WienAuch wenn manche vorher vielleicht gezweifelt haben mögen: Wien war eine ausgezeichnete Wahl für die diesjährige Frühjahrstagung. Nicht nur weil das Austria Center einen hoch professionellen Rahmen (fast) im Herzen Wiens geboten hat, sondern auch weil durch diese Wahl unsere südlichen Nachbarn (und wiederum deren Nachbarn) einmal zu ihrem Recht gekommen sind. Neben vielen alten Bekannten habe ich auf dieser Tagung auch eine Menge neue Gesichter gesehen und im Gespräch hat mir die eine oder der andere erzählt, dass Wien als Standort ausschlaggebend dafür war, dass sie die Teilnahme genehmigt bekommen haben. Weiterlesen

Leichte Sprache mit Fundament

Rezension „Leiche Sprache – Kein Regelwerk“Leichte Sprache ist für uns im doctima Blog ja ein Thema, das uns seit vielen Jahren begleitet. Und nun gibt es endlich eine Neuerscheinung zu melden, auf die ich persönlich seit vielen Jahren gewartet habe. Das Buch, das diese Lücke schließt, heißt „Leichte Sprache – kein Regelwerk“. Im ersten Moment mag dieser Titel ein wenig verwundern. „Kein Regelwerk“ – Ist nicht genau ein Regelwerk das, was man für leichte Sprache braucht? Weiterlesen

Systeme mit System

CCMS, TMS, WCMS, TVS, CLC, AMSIn der Technischen Dokumentation sind wir darum bemüht, Texte und Inhalte allgemein verständlich und in Formulierung und Darstellung konsistent zu gestalten. Dabei nutzen wir diverse Werkzeuge, d. h. in unserem Fall: Software-Systeme, die uns bei der Erstellung und Verwaltung der Inhalte unterstützen. Im Laufe der Zeit hat sich eine ganze Palette von Systemen herausgebildet, die jeweils auf bestimmte Teilaufgaben spezialisiert sind. Und natürlich hat jedes dieser Systeme seine eigene Bezeichnung, und zusätzlich noch eine Abkürzung, was zu einer terminologischen Vielfalt führt, für die man fast schon wieder ein eigenes Verwaltungssystem bräuchte … Heute bringen wir Ordnung in dieses Dickicht und stellen die wichtigsten Systeme im Bereich der Technischen Dokumentation vor – mit System.

Weiterlesen

Screenshots einfach und schnell mit Greenshot

Screenshots machen gehört zum Alltag in Technischen Redaktionen. Ob in Bedienungsanleitungen, Online-Hilfen oder für Schulungen – oft gilt es zu zeigen, was der Benutzer an seinem Monitor sieht oder zumindest sehen sollte. Gerade wenn man zahlreiche Screenshots machen muss, kann eine spezielle Software enorm unterstützen. Sie stellt mehr Funktionaltiät bereit als die Standardfunktion im Betriebssystem. Wir bei doctima setzen seit langem auf Greenshot für Windows, ein schlankes Tool mit vielen nützlichen Funktionen. Weiterlesen

Auf der Suche nach der richtigen Suche

Information ist in der heutigen Zeit leicht zugänglich und im Überfluss vorhanden. Ohne Suchfunktionen wären wir bei der Bewältigung eines Informationspools wie z. B. dem Internet aufgeschmissen.

Auch für viele Anwendungen in der Technischen Dokumentation bieten sich Suchfunktionen an. In einer Doku-App auf dem Smartphone oder bei einer eingebetteten Maschinenhilfe, die man über einen Touchscreen bedient, nimmt eine Suche dem Nutzer die Arbeit ab, Navigationsstrukturen oder große Dokumente durchforsten zu müssen, um die gewünschte Informationen zu finden. Weiterlesen

Fehlermeldungen, die wirklich weiterhelfen

Fehlermeldungen in Apps und Websites richtig schreiben„Warum funktioniert das nicht?“ „Was ist denn jetzt schon wieder?“

Diese Gedanken kommen schon mal auf beim alltäglichen Umgang mit Apps, Websites und Programmen. Auch wenn man sie ungern sieht: Eine Fehlermeldung hilft an dieser Stelle weiter – wenn sie gut ist.

Vor kurzem hatten wir bei doctima die Aufgabe, für einen Kunden Fehlermeldungen für eine App zu erstellen. Der erste Gedanke: „So schwer kann das gar nicht sein. Wir schreiben ja auch Sicherheitshinweise und eigentlich ist das ganz ähnlich.“ Eigentlich – und eigentlich auch wieder nicht, denn Fehlermeldungen benötigen eine etwas andere Expertise. In diesem Blogpost gebe ich einen kleinen Einblick in unsere Erfahrungen mit diesem spannenden Thema und ein paar Tipps, wie Sie selber gute Fehlermeldungen erstellen. Weiterlesen