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

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

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

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

Schreiben und checken

Rezension Checkliste Schreibprozess, Wymann & NeffMit Checklisten beschäftigt sich nicht nur meine Kollegin Ulrike (z. B. hier und hier), sondern auch ein utb-Ratgeber, der vor kurzem den Weg zu mir auf den Schreibtisch gefunden hat. Christian Wymann und Franz Neff haben eine „Checkliste Schreibprozess“ vorgelegt. Sie soll wissenschaftlich Arbeitenden helfen, ihre Schreibprojekte bewusster zu steuern und einen eigenen Weg für die Gestaltung ihrer Schreibprojekte zu finden.

Mich haben bei diesem Buch vor allem zwei Fragen bewegt:

  • 1. Wie gut lässt sich mit dem Buch ein Schreibprozess gestalten?
  • Und 2. Was davon lässt sich auf die Technische Redaktion übertragen?

Die Anforderungen sind hier ja oft anders als in der Wissenschaft… Weiterlesen

Barrierefreie Kommunikation: ein Handbuch (Buchrezension)

Von Bahnhöfen über Duschkabinen bis zu Internetseiten – dem Schlagwort „Barrierefreiheit“ begegnet man seit einigen Jahren in fast allen Lebensbereichen.

Mit dem „Handbuch Barrierefreie Kommunikation“ ist nun ein 800-seitiges Kompendium erschienen, das den vielschichtigen Bereich der zwischenmenschlichen Verständigung unter diesem Aspekt behandelt. Wie gut das gelingt und wer von diesem Handbuch profitieren kann – wir haben es uns genauer angeschaut.

Weiterlesen

Software-Anleitungen verständlich schreiben (Buchrezension)

Buchcover "Software-Anleitungen verständlich schreiben"Bis vor kurzem habe ich für doctima in einem großen Softwareunternehmen gearbeitet. In dieser Zeit habe ich Software-Anleitungen in einem CMS geschrieben und gepflegt, an Konzepten gefeilt und mein Augenmerk auf Verständlichkeit gelegt. Deshalb machte mich der Titel des neuen Buchs von Dietrich Juhl sofort neugierig: „Software-Anleitungen verständlich schreiben. Konzepte, Strukturen, Beispiele“. Ich fragte mich: Welche Herangehensweisen zeigt dieses Buch auf, an die ich noch gar nicht gedacht habe? Inwiefern deckt meine Praxiserfahrung sich mit der des Autors? Weiterlesen

So war die SCHEMA Conference 2018

doctima bei der SCHEMA Conference 2018

Der Stand von doctima bei der SCHEMA Conference 2018

Letzte Woche war es wieder soweit: Die SCHEMA-Gruppe veranstaltete ihre eigene Konferenz. Wir von doctima sind dort traditionell als Partner und mit Vorträgen vertreten. Als einer von nur drei Goldpartnern am deutschen Markt sind wir in der ST4-Welt sehr stark vernetzt und somit war ich mit einem Stand vor Ort als Ansprechpartner für Interessenten, Kontakte und Kunden. Weiterlesen

Auswirkungen maschineller Übersetzungen auf die Technische Dokumentation

Christian Weih, Mitglied des Management Boards bei Across Systems GmbH

Im vierten Teil unserer Reihe „Trends in der Technischen Dokumentation“ begrüßen wir Herrn Christian Weih. Herr Weih ist Mitglied des Management Boards bei der Across Systems GmbH. Mit seinen Softwarelösungen unterstützt Across Systems Unternehmen und Übersetzer auf der ganzen Welt bei der erfolgreichen Abwicklung ihrer Übersetzungsprojekte. Kunden aus den unterschiedlichsten Branchen nutzen den Across Language Server und die Across Translator Edition, um ihren täglichen Herausforderungen bei der Lokalisierung von Technischen Dokumentationen oder Marketingtexten (z. B. im Bereich E-Commerce) zu begegnen.

Innerhalb der letzten Jahre haben sich die Anzahl und die Volumen von Übersetzungen für viele Unternehmen stark erhöht, teilweise sind sie sogar dramatisch gestiegen. Gleichzeitig werden die Produktlebenszyklen zunehmend kürzer, und die Time-to-Market wird immer straffer geplant. Für Übersetzungsverantwortliche bedeutet dies, dass sie möglichst alle Optionen nutzen sollten, die die Lokalisierung beschleunigen, ohne dass die Übersetzungsqualität darunter leidet. Weiterlesen

Zufriedene Leser und besseres Ranking: 7 Schritte für Ihre Onlinetexte

Suchmaschinenoptimierung ist wie Schwimmen gegen den Strom: Lässt man nach, fällt man zurück.

Suchmaschinenoptimierung lässt sich sehr gut mit Schwimmen gegen den Strom vergleichen: Lässt die Kraft nach, so fällt man unweigerlich zurück. Glücklicherweise ist das Schreiben von suchmaschinenfreundlichen Texten bei weitem nicht so anstrengend. Die Grundregeln sind einfach zu erlernen und gehen schnell in Fleisch und Blut über.

Wir haben Ihnen 7 Schritte zusammengestellt, mit denen Sie zwei Fliegen mit einer Klappe schlagen: zufriedene Leser und ein besseres Ranking bei Google & Co. Weiterlesen