Warum Sie die Technische Redaktion bei agilen Projekten gleich mit ins Boot holen sollten

Agile DokumentationInsbesondere in der Softwareentwicklung setzen sich agile Vorgehensmodelle wie Scrum immer mehr durch. Der Grundgedanke hinter dem agilen Ansatz – den Projektfokus immer auf den Anwendernutzen zu legen – ist für reine Entwicklerteams allerdings nicht immer leicht umzusetzen. Ein Scrum-Team mit Product Owner und Entwicklern hat einen ganz anderen Blick auf die eigene Software als deren Anwender. Man kennt deren Innenleben und tut sich mit diesem Zusatzwissen oft schwer, mit den Augen eines Außenstehenden darauf zu blicken. Weiterlesen

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

Kennzahlen – die unbekannten Wesen: Statistische Logik (Teil 4)

Kennzahlen - die unbekannten Wesen, strategisches VorgehenMit dem Beitrag „Statistische Logik“ geht unsere Reihe „Kennzahlen – die unbekannten Wesen“ zu Ende. Vielen Dank noch einmal an Herrn Prof. Schaffner, der die Kennzahlen für uns zu bekannten Wesen gemacht hat! Wie schon bei den letzten Artikeln, finden Sie eine Übersicht der Reihe am Ende des Artikels.

Kennzahlen basieren oft auf eindimensionalen Datenreihen (x1, x2, x3, … xn), die durch Mittelwerte gekennzeichnet werden. Beispiel: Aus 110 Dokumenten wird zufällig eine 10%-Stichprobe gezogen, deren Orthografiefehler gezählt und auf 1.000 Wörter normiert werden. Weiterlesen

Kennzahlen – die unbekannten Wesen: Empirische Arbeit (Teil 3)

Kennzahlen - die unbekannten Wesen, strategisches VorgehenIn Teil 3 macht sich Prof. Schaffner mit uns gemeinsam an die empirische Arbeit. Haben Sie Teil 1 und 2 schon gelesen? Falls nicht: Am Ende des Artikels sind alle bereits erschienen Beiträge der Reihe verlinkt.

Unter empirischer Arbeit wird die methodisch-systematische Sammlung von Daten und die regelgeleitete Erkenntnisgewinnung verstanden. Daten können qualitativ (nicht-numerisch) oder quantitativ sein (mess- oder zählbar). Kennzahlenarbeit ist zunächst einmal quantitative Empirie (z.B. Umsatz, Fehlerquote, Wiederverwendungsquote). Weiterlesen

Grafikformate und ihre Tücken – Teil 2: Tücken

Datenformate Export Technische DokumentationIm ersten Teil dieses Artikels hat meine Kollegin Katharina neben Grundlagen zu den gängigsten Grafikformaten bereits auf einige Fallstricke beim Verwenden digitaler Grafiken in der Redaktionsarbeit hingewiesen.

  • Pixelgrafiken sind nicht besonders gut für technische Zeichnungen geeignet.
  • Vektorgrafiken liegen häufig in proprietären Formaten vor. Die großen Mitspieler Microsoft und Adobe bilden eigene Welten mit nur bedingt durchlässigen Grenzzäunen aus.
  • Fehlt die Originalgrafikdatei, lassen sich Grafiken manchmal nur mit Mühe aus Bestandsdokumenten extrahieren.

Lassen Sie uns etwas tiefer einsteigen. Weiterlesen

Kennzahlen – die unbekannten Wesen: Strategische Früherkennung (Teil 2)

Kennzahlen - die unbekannten Wesen, strategisches VorgehenWir setzen unsere Reihe „Kennzahlen – die unbekannten Wesen“ fort. Prof. Michael Schaffner erklärt uns heute die strategische Früherkennung und das Konzept der schwachen Signale. Eine Übersicht der vier Artikel finden Sie am Ende des Beitrags.

Kennzahlen sind Informationen der Vergangenheit. Dennoch werden sie oft als Indikatoren für künftige Entwicklungen eingesetzt. Wir sind jedoch umgeben von hoher Dynamik und Komplexität. Da können Kennzahlen zwangsläufig scheitern. Die Strategische Frühaufklärung setzt daher auf „schwache Signale“. Anstatt auf klassische Kennzahlen der operativen Frühwarnung zu vertrauen, ist die Fahndung nach „weak signals“ ein kontinuierlicher Prozess. Weiterlesen

Grafikformate und ihre Tücken – Teil 1: Grundlagen

Datenformate Export Technische DokumentationAuch wenn sich die Technische Dokumentation in Word oder InDesign erledigen lässt, so sind diese Programme sicherlich nicht das Optimum für diesen Zweck. Die Wiederverwendung von Inhaltsbausteinen, Varianten- und Übersetzungsmanagement – all diese Aufgaben lassen sich einfacher mit speziellen Redaktionssystemen erledigen.

Ist der Umstieg auf ein solches System geplant, stellt sich meist die Frage: Wie bekommen wir unsere Inhalte aus dem alten System in das neue? Beim Export/Import z. B. mittels XML stellen sich ganz neue Herausforderungen einfach dadurch, dass Programme wie Word und InDesign sehr eigen sind bei der Verarbeitung bestimmter Dateiformate. Was auf den ersten Blick einfach scheint, kann in der Praxis zu grauen Haaren führen. Das gilt vor allem für den Export von Grafiken. Weiterlesen

Kennzahlen – die unbekannten Wesen: Schlüssiges Vorgehen (Teil 1)

Kennzahlen - die unbekannten Wesen, strategisches VorgehenDas Thema Kennzahlen für Technische Redaktionen beschäftigt uns sehr, nicht nur hier im Blog. Umso mehr freuen wir uns über die Gastartikelreihe von Prof. Michael Schaffner. In vier Beiträgen wird er Ihnen und uns die unbekannten Wesen Kennzahlen näherbringen. Seien Sie sicher: Hier wird nicht an der Oberfläche gekratzt, sondern es geht so richtig ans Eingemachte! Wir sagen Danke an Herrn Prof. Schaffner, dass er sein Wissen hier mit uns teilt, und freuen uns auf die nächsten Wochen Kennzahlen pur. Weiterlesen

Die unsichtbare Frau

Gendergerechte Sprache in der Technischen DokumentationZu Beginn gleich ein paar provokante Fragen vorweg: Sind Frauen in der Technischen Dokumentation unsichtbar? Entfalten Anleitung ihre volle Wirkung für die gesamte Leserschaft – oder doch nur für die (männliche) Hälfte?
Diesen Fragen wollen wir hier nachgehen und dabei einen Blick auf (alte) Gewohnheiten, relevante Urteile, anekdotische Befunde und wissenschaftliche Studien werfen. Weiterlesen