Systemeinführung und Systemwechsel – aber wie?

Content Managment System Systemeinführung und SystemwechselWenn ich mit Interessenten oder Kunden über die Einführung eines Content-Management-Systems (CMS) spreche, dann haben wir uns in der Regel bereits Gedanken darüber gemacht und teilweise auch schon konkret über den Ablauf einer Systemeinführung gesprochen oder sogar schon Vorarbeiten umgesetzt. Im Gegensatz dazu wird in zwei Monaten bei der Jahrestagung der tekom von vielen Besuchern an unserem Stand die Frage kommen: „Was kommt denn da auf uns zu wenn wir ein Redaktionssystem einführen oder wechseln?“ Nun… eine allgemeingültige Antwort gibt es darauf nicht. Weiterlesen

Stand der Technik für Nutzungsinformationen: Die neue Edition der IEC 82079-1

SicherheitshinweiseDie neue Norm für Nutzungsinformationen IEC/IEE 82079-1, die seit Mitte Mai vorliegt, hat für uns Technische Redakteure einiges zu bieten. Ein Blick in die Norm lohnt sich!

Schon allein der Titel „Preparation of information for use (instructions for use) of products“ verrät, dass der Geltungsbereich der Norm etwas weitreichender ist als ihr Vorgänger. Mit „Information for use“ sind nicht nur Handbücher und Dokumentationen gemeint, sondern sämtliche Informationen über den Gebrauch des Produkts. Dazu gehören auch Online-Hilfen, Labels, Videos, Schulungen, Bildschirmtexte u.v.m. Weiterlesen

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

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

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

Karriere in der Technischen Redaktion: Von der Uni ins Berufsleben

Karriere Technische RedaktionVor ein paar Wochen haben wir hier im Blog darüber geschrieben, worauf Bewerber achten sollten, wenn sie sich in Technischen Redaktionen – speziell hier bei doctima – bewerben wollen. Heute kommen diejenigen zu Wort, die die Bewerbungsphase schon eine Weile hinter sich haben: Ulrike, Maria und Lisa haben alle an der Hochschule Merseburg studiert und sind seit ein paar Jahren bzw. Monaten im Team doctima als Technische Redakteurinnen mit ganz unterschiedlichen Aufgaben. Sie erzählen, was sie konkret machen und wie der Einstieg ins Berufsleben als Technischer Redakteur so lief. Weiterlesen

Datenschutzgrundverordnung: (K)ein Thema für die Technische Dokumentation

Die DSGVO spielt auch in der Technischen Dokumentation eine Rolle.Wie haben Sie den 25. Mai verbracht? Wenn Sie selber Unternehmer sind oder in einem Unternehmen für den Datenschutz zuständig sind, gibt es eigentlich nur ein paar mögliche Geisteszustände: erschöpft, verwirrt und genervt.

Seit dem 25. Mai ist die neue europäische Datenschutzgrundverordnung (DSGVO) gültig. In Kraft trat sie bereits 2016. Erst in den letzten Wochen waren deutliche Erschütterungen im Internet und in so manchen Büros  zu spüren. Auch bei uns gab und gibt es ein paar graue Haare mehr oder insgesamt ein paar Haare weniger, denn das Thema ist schon ein wenig zum Haareraufen. Doch was ändert sich jetzt mit der neuen DSGVO und wieso ist die neue Verordnung auch für die Technische Dokumentation ein Thema? Weiterlesen

Tipps für eigene Word-Vorlagen in der technischen Dokumentation

Eigene Word-Vorlagen sind in der technischen Dokumentation sinnvoll.Vor ein paar Tagen erst habe ich letzte Hand angelegt an eine Word-Dokumentvorlage, die ich für einen Kunden aus dem Maschinenbausektor erstellt habe. „Was? Ihr arbeitet als Kommunikations-Profis noch mit Word?“, werden Sie sich vielleicht fragen. Ja, das tun wir – und vor allem tun es auch unsere Kunden.

Für „echte“ Dokumentationsprojekte verwenden wir Word nur noch sehr selten, da sind meist Profi-Tools im Einsatz, vor allem Content-Management-Systeme wie SCHEMA ST4. Aus dem Alltag der sonstigen technischen Textsorten wie Lasten- und Pflichtenhefte ist Word als Werkzeug aber lange noch nicht wegzudenken. Weiterlesen

Digital oder Papier? Vorteile der mobilen Dokumentation

Mobile Dokumentation per App hat viele Vorteile gegenüber Papier.

Digitalisierung, Industrie 4.0 und das Internet of Things verändern auch die Art, wie wir über Technische Dokumentation denken. Eine der ersten Maßnahmen auf dem Weg zu „Information 4.0“ ist es, die Dokumentation weg von der Kapitelstruktur themenbezogen zu strukturieren und sie mithilfe von Metadaten semantisch zu markieren.

Anstatt Handbücher auf Papier oder als A4-formatierte PDF-Datei auszuliefern, erzeugen wir auf dieser Basis dynamische Informationen in HTML5, die sich auf unterschiedlichen Displays, auf Maschinenkonsolen oder auf Mobilgeräten verteilen und betrachten lassen. Weiterlesen

tekom 2017, die Doku-Branche zu Besuch in Stuttgart

Vier Wochen ist es her, dass wir auf der tekom-Jahrestagung 2017 waren. Viel ist seitdem passiert, wir sind schon voll im konkreten Austausch mit Kontakten von der Tagung. Dazu beigetragen hat sicherlich unser iiRDS-Szenario mit unserem Roboterarm. Einerseits Eyecatcher, andererseits die anschauliche Darstellung, wie automatisierte Prozesse und Informationsflüsse in Unternehmen heutzutage ablaufen. Weiterlesen