Free Press

Wir machen dort weiter, wo wir in Teil 1 der Serie über Technical Writing Tools aufgehört haben. (Lesen Sie es nach, wenn Sie es noch nicht gelesen haben)
In dieser Folge befassen wir uns mit den Werkzeugen für die technische Redaktion, die in der Phase „Information dokumentieren“ verwendet werden.
Dies ist die Phase des Schreibens, Bearbeitens, Zeichnens, Überprüfens und Umschreibens. Dies ist die Phase, in der das Informationsdokumentationsteam seine ganze Kraft einsetzt, um Leitfäden, Handbücher, Blogs, Videodemos, Online-Hilfeseiten und dergleichen zu erstellen. In Anbetracht der Vielfalt der Aufgaben in dieser Phase sind auch die eingesetzten Werkzeuge für die technische Redaktion sehr vielfältig und zahlreich.

Top 17 Technical Writing Software Tools für die Dokumentation im Jahr 2020

• • Whatfix
  • MediaWiki
  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator
• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix bedeutet einen Paradigmenwechsel in der Art und Weise, wie Hilfedokumentation online präsentiert wird. Statische und langatmige Web-Hilfeseiten ziehen die Aufmerksamkeit des Benutzers nicht so sehr auf sich wie die interaktiven, bebilderten Anleitungen von Whatfix, im Volksmund „Sprechblasen“ genannt.
Außerdem muss die Online-Hilfe in der heutigen Welt auf verschiedene Geräte verteilt werden – seien es PCs, Tablets oder Smartphones. Whatfix passt die Hilfeinhalte automatisch an das jeweilige Endgerät an. Und derselbe Hilfeinhalt kann in verschiedenen Formen abgerufen werden – als Diashow, PDF oder Video.
Tipp des Autors: Whatfix unterstützt eine einzigartige Funktion – Real-time Interactive walkthrough – bei der Sie Ihre Hilfetexte direkt in die Live-Produktseite einfügen! Der Benutzer liest das Snippet in der Whatfix-Sprechblase und führt die entsprechende Aktion auf der Seite aus. Dies ist ein beliebtes Werkzeug für die technische Redaktion in Unternehmen, die eine Abkehr von den traditionellen Methoden suchen.

MediaWiki

Die Online-Hilfe Ihres Produkts als Wiki-Seiten darzustellen ist eine einfache und effektive Idee. Ihre Seiten können direkt in Wikipedia integriert werden, wenn Sie keine eigene Website für Ihr Online-Produkt haben. Alternativ können Sie die Wiki-Hilfeseiten auch auf Ihrer Produktwebsite hosten. Der hohe Bekanntheitsgrad dieses Formats unter Online-Nutzern ist ein entscheidender Vorteil, und das kostenlose Wiki-Editierwerkzeug MediaWiki Visual Editor macht die Erstellung von Hilfeseiten ganz einfach.
MediaWiki ist ein PHP-basiertes Web-Editierwerkzeug, das auch Wikipedia verwendet. Aber auch große Softwareunternehmen, wie z.B. Intel, verwenden dieses Tool, um ihre Vertriebs- und Marketinginformationen, Anleitungen und Hilfeseiten zu Richtlinien und Verfahren zu präsentieren.
Tipp des Autors: Dieses Tool für die technische Redaktion bietet eine gute Unterstützung für Erweiterungen – für mehrsprachige Inhalte, gemeinsame Überarbeitung, Nachverfolgung von Änderungen, integrierte Suche usw.

Adobe RoboHelp

Industriestandard-Authoring-Tool für die Erstellung von Hilfesystemen für Desktop- oder webbasierte Anwendungen. RoboHelp ist für jeden Computerbenutzer ein Begriff! Jedes Mal, wenn Sie in einer Ihrer Standardsoftwareanwendungen die Taste F1 drücken, wird das erscheinende Hilfefenster fast immer mit RoboHelp erstellt. Die hochentwickelte RoboHelp-IDE ermöglicht es technischen Redakteuren, umfangreiche Hilfsprojekte zu entwickeln und sie auf verschiedenen Hardware-Geräten/Betriebssystemen und in verschiedenen Formaten (PDF, HTML, DOC usw.) darzustellen. Die ältere Version von RoboHelp kann als Low-Cost-Edition erworben werden, wenn das Budget nicht ausreicht. Kleine Unternehmen können sich jedoch auch mit einfachen, kostenlosen Alternativen wie WordPress-Blogs oder Wikis begnügen. Das gute alte MS Word kann auch einfache HTML-Hilfedateien für Sie erstellen.
Tipp des Autors: Die Verwaltung großer Softwareprodukte mit regelmäßigen Upgrade-Versionen kann eine große Herausforderung für technische Redakteure sein, da sie mit der Änderungshistorie des Produkts Schritt halten müssen. Hilfedateien enthalten oft konfigurierbare benutzerdefinierte Variablen, die in der gesamten Hilfedokumentation mehrmals wiederholt werden. (Zum Beispiel ist eine Variable wie „Ruhezeit nach Inaktivität“ in der Vorgängerversion auf 30 Sekunden eingestellt, die in der neuen Version auf 1 Minute gesetzt werden soll). Das RoboHelp-Projekt würde sich um die Aktualisierung der Variablenwerte in den Hilfedateien kümmern!

Notepad++

Ein sehr effektiver HTML-Editor für Anfänger. Die meisten Leute lernen die Grundlagen der HTML-Programmierung mit diesem Werkzeug für die technische Redaktion. Wenn Ihr Softwareprodukt keine sehr umfangreiche Online-Hilfedokumentation erfordert, ist dieses Tool für die Erstellung von Hilfedateien mittlerer Größe mehr als ausreichend.
Die anpassbare Benutzeroberfläche ermöglicht eine einfache Bearbeitung, unterstützt WYSIWYG für den Druck und bietet außerdem Optionen für die Unterstützung mehrerer Sprachen.
Tipp des Autors: Notepad++ wird mit einer Vielzahl von Plug-ins geliefert. Multi-Clipboard, Code-Vergleich, Auto-Save sind einige der beliebtesten. Technische Redakteure müssen die richtige Auswahl an Plug-ins treffen, die einen gewöhnlichen Einsteiger-Editor in eine brauchbare Option für die Online-Hilfebearbeitung verwandeln können.

WordPress

Die erste Adresse, wenn Sie technische Dokumentation für Ihr Produkt in Form von Blogs erstellen möchten. WordPress ist eine kostenlose Open-Source-Plattform zur Verwaltung von Online-Inhalten. Auf WordPress geschriebene Blogs können entweder direkt über die URL des WordPress-Blogs aufgerufen oder in die Website Ihres Unternehmens integriert werden.
Dieser Artikel selbst wird auf dem WordPress-Blog namens Whatfix Academy gehostet. Wenn das Ziel darin besteht, regelmäßig Online-Inhalte über Ihr Unternehmen bzw. die damit verbundenen Technologien zu veröffentlichen, sollten Sie ein WordPress-Blog-Konto einrichten. Blogs können auch Reaktionen von Nutzern in Form von Kommentaren und Likes erfassen, was es einfacher macht, mit Ihrer Zielgruppe in Kontakt zu treten und deren Wertschätzung für Ihr Produkt zu spüren.
Tipp des Autors: Blogs für sich genommen können nicht genügend Aufmerksamkeit erregen. Schreiben Sie also zuerst Ihren Blog, promoten Sie ihn dann auf Social-Media-Plattformen und messen Sie schließlich die Zuschauerzahlen/Reaktionen, bevor Sie mit der nächsten Reihe von Blogs weitermachen!
Lesen Sie auch: Wie sich das technische Schreiben mit der Zeit verändert

Adobe Photoshop

Ein Tool, auf das die meisten technischen Redakteure in der Branche schwören. Es ist das weltweit beliebteste Bildbearbeitungsprogramm zum Erstellen und Bearbeiten von Fotos und rasterbasierten (Pixel-)Grafiken. Es kann für die Erstellung von Benutzeroberflächen, Webseiten, Werbebannern, Videografiken und die Bearbeitung von Bildern für den Druck verwendet werden. Das Manipulieren eines Bildes, das Überlagern eines Bildes über ein anderes, das Verfeinern eines Fotos, um Unvollkommenheiten auszubügeln, das Korrigieren von Beleuchtungsproblemen sind die beliebtesten Anwendungen. Der Bildbearbeitungsprozess ist umkehrbar und schrittweise, so dass Änderungen leicht rückgängig gemacht werden können.
Tipp des Autors: Für professionelle Designer, die ständig ein Bildbearbeitungsprogramm benötigen, gibt es kaum einen Ersatz für Adobe Photoshop. Wenn Sie jedoch nur gelegentlich damit arbeiten, sollten Sie GIMP ausprobieren, das Open Source ist. Es unterstützt allerdings nur RGB-Farbschemata, während Photoshop auch den CMYK-Farbmodus (CYAN YELLOW MAGENTA BLACK) unterstützt. Und die Lernkurve ist bei GIMP höher, aber es ist kostenlos, während Photoshop eine Bombe kostet!

Adobe Illustrator

Tool zum Erstellen und Bearbeiten von vektorbasierten Illustrationen wie Logos und Markenzeichen oder anderen Designelementen. Grafikdesigner machen oft den Fehler, ihre Produktlogos in Photoshop zu entwerfen. Aber das gleiche Logo muss auf Visitenkarten und großen Werbetafeln gedruckt werden. Der Schlüssel dazu ist die Skalierung des Bildes, ohne dass die Klarheit verloren geht, was mit vektorbasierten Bildbearbeitungsprogrammen möglich ist. Adobe Illustrator und Corel Draw sind die führenden Werkzeuge für die technische Redaktion in diesem Bereich.
Tipp des Autors: Dieses Tool ist Teil der Adobe Creative Cloud-Lösung mit teuren monatlichen Mietgebühren. Kostenlose alternative Werkzeuge für die technische Redaktion wie Inkscape oder Affinity Designer können die Arbeit mit SVG-Formaten ebenso gut erledigen. Wenn Sie nicht alle wichtigen Tools für die technische Redaktion benötigen, die Teil dieser Lösung sind (Photoshop, InDesign usw.), ist dieses Tool kein Muss.

Microsoft Visio

Ein beliebtes Diagrammwerkzeug, das bei der Entwicklung technischer Anwendungen verwendet wird. Technische Redakteure müssen oft Flussdiagramme, architektonische Diagramme, elektrische Schaltpläne, Software-Produktdesign und so weiter entwerfen. Visio ist ein praktisches Hilfsmittel dafür.
Es ist ein IEEE-konformes Werkzeug für die technische Redaktion, das den Standards der Softwareindustrie wie UML (Unified Modeling Language) und BPMN (Business Process Model and Notation) entspricht.
Tipp der Autoren: Visio war nicht Teil der traditionellen Microsoft Office-Suite, sondern wurde immer separat verkauft, ähnlich wie MS Project. Aber eine sehr aktuelle Ankündigung von Microsoft besagt, dass Online-Abonnenten von Office 365 jetzt auch auf Visio zugreifen können.

Windows Snipping Tool

Wenn Sie nach Optionen für die Bildschirmaufnahme suchen, die anspruchsvoller sind als PrntScr auf Ihrer Tastatur, ist Snipping Tool eine gute Wahl. Neben der Erfassung des gesamten Bildschirms können Sie auch Freihandausschnitte oder Teilbereiche des Bildschirms erfassen. Um Standbilder aus Videos zu erfassen, verwenden Sie die Option „Verzögerung“, damit der genaue Rahmen als Bild gespeichert werden kann.
Tipp des Autors: Es ist Teil der Windows-Softwaresuite, aber in einigen Windows-Editionen möglicherweise nicht standardmäßig aktiviert.

Windows Movie Maker

Ein einfaches Video-Editor-Tool, mit dem technische Redakteure ihre Produktdemovideos erstellen können. Es ist Teil der Windows Essentials Suite. Seit Januar 2017 ist diese Software jedoch eingestellt worden, ohne dass ein adäquater Ersatz angekündigt wurde. Alle Nutzer mit älteren Windows-Versionen können sich also glücklich schätzen!
Autoren-Tipp: Videos und Audio-Clippings können in einer Storyboard-Ansicht Bild für Bild angeordnet und bearbeitet werden. Oder eine Reihe von Standbildern kann auf einer Zeitachse gestreckt werden. Audiokommentare, die mit Hintergrundgeräuschen kombiniert werden, können Ihren Videos eine besondere Note verleihen.

Powtoon

Technische Texte werden zunehmend visuell. Animierte Videos sind ein hervorragendes Mittel, um die Aufmerksamkeit der Nutzer zu gewinnen und die Botschaft auf ansprechende Weise zu vermitteln. Powtoon ist ein gutes webbasiertes Animationstool, das als SaaS-Produkt verkauft wird. Animierte Präsentationen und Erklärvideos können mit diesem Tool kostenlos erstellt werden. Allerdings sind die mit der kostenlosen Version erstellten Videos mit einem „Powtoon“-Wasserzeichen versehen.
Tipp des Autors: Wenn das technische Schreiben nicht für offizielle Zwecke bestimmt ist, ist es völlig in Ordnung, die kostenlose Version dieses Tools zu verwenden. Gegen eine geringe Gebühr können Sie jedoch die Premium-Version erwerben, die es Ihnen ermöglicht, Videos ohne Wasserzeichen und mit verschiedenen anderen Funktionen zu erstellen.

Prezi

Eine unkonventionelle Art, Demos in Form einer Videopräsentation zu erstellen. Im Gegensatz zu Powerpoint, wo der Inhalt starr in Folien unterteilt ist, gibt Ihnen Prezi nur eine große leere Leinwand. Sie können darauf schreiben und zeichnen, wie Sie wollen. Sie können in den Inhalt hinein- oder herauszoomen und den Fokus von einem Bild zum nächsten auf derselben Leinwand verschieben – so erstellen Sie eine fortlaufende Videopräsentation.
Autoren-Tipp: Neben der kostenlosen Version gibt es auch eine Testversion für Studenten, die ebenfalls kostenlos ist und fast alle Funktionen der kostenpflichtigen Version hat. Wählen Sie diese aus.
Lesen Sie auch – 14 Irrtümer beim Technischen Schreiben, die Sie kennen sollten!

Microsoft Word

Es fühlt sich etwas albern an, über das allgegenwärtige MS Word zu schreiben. Aber so alltäglich es in unserem digitalen Leben auch sein mag, es ist immer noch der beste Freund eines technischen Redakteurs! Durch die einfache Konvertierung zwischen PDF- und DOC-Formaten ist die einfache Kombination von Word und Adobe Acrobat Reader nicht zu unterschätzen. Dieser Artikel mag sich mit all den ausgefallenen Werkzeugen für die technische Redaktion befassen, aber er wird mit dem bescheidenen MS Word verfasst!
Tipp des Autors: Experimentieren Sie mit den verschiedenen Dokumentvorlagen, die Word anbietet. Sie helfen dabei, Ihr Dokument für den beabsichtigten Zweck angemessen aussehen zu lassen – als Marketing-Flyer, technisches Whitepaper, Anleitung zur Fehlerbehebung und so weiter.

Kingsoft WPS Office

MS Word, PowerPoint und Excel sind bekanntlich die am häufigsten verwendeten Software-Tools für das technische Schreiben und liegen meilenweit vor den verfügbaren Alternativen. Nur die Android-Revolution hat den MS-Office-Moloch ein wenig gebremst. Und Kingsoft Office, einer vernünftigen und kostenlosen Alternative zu MS Office, eine herausragende Stellung eingeräumt.
Autorentipp: Es gibt einige Funktionen, die WPS Writer nicht unterstützt – Thesaurus ist eine davon. Thesaurus ist eine wichtige Funktion für technische Redakteure, da wir ständig auf der Suche nach besseren Wörtern sind, um dieselben Punkte in verschiedenen technischen Dokumenten auszudrücken!

Google Docs

In einer Welt, die sich zunehmend einem handlichen Mobiltelefon zuwendet, um Dokumente zu lesen, anstatt sich die Mühe zu machen, den Computer einzuschalten, gewinnt Google Docs langsam an Bedeutung. Die Erstellung von Dokumenten von Grund auf ist mit Google Docs nicht möglich, aber die gemeinsame Überprüfung und Bearbeitung kann mit dieser Cloud-basierten Alternative zu MS Office effizient durchgeführt werden.
Tipp des Autors: Die nahtlose Integration mit Google Mail und Google Drive macht es noch attraktiver. Als technischer Redakteur würden Sie sich an die hochentwickelten Textverarbeitungsprogramme halten. Aber Ihr Produktmanager, der vielleicht ständig unterwegs ist, wird seine Rezensionen höchstwahrscheinlich auf seinem Telefon nachholen!

Adobe Framemaker

Ein hochentwickelter Dokumentenprozessor für große, industrielle Standarddokumente. Kann verwendet werden, um strukturierte Dokumente mit einem XML-Framework zu generieren, mit 100%iger DITA-Konformität. Kann auch für unstrukturierte Dokumente verwendet werden, als Ersatz für Dokumenten-Editoren wie MS Word.
Framemaker ist eine gute Wahl für die Erstellung strukturierter Dokumente mit vordefinierten Vorlagen, die verschiedenen Industriestandardformaten entsprechen – wie z. B. Rechtsvereinbarungen und Jahresabschlüsse. Es unterstützt die Erstellung von Inhaltsverzeichnissen oder Indizes für mehrere Dokumente und verfügt über umfangreiche Formatierungsoptionen. Die Leistung lässt nicht nach, wenn Grafiken eingefügt werden.
Tipp des Autors: Framemaker ist eine sinnvolle Investition für etablierte Unternehmen mit formellen Teams für die technische Redaktion, die umfangreiche Dokumente von über 100 Seiten erstellen müssen. Unternehmen, die nur ein Produkt herstellen, und Start-ups müssen diese Investition jedoch nicht tätigen. Es gibt kostenlose XML-basierte Tools zur Erstellung von Dokumenten, die kostenlos erhältlich sind. Und Sie können jederzeit auf das gute alte MS Word zurückgreifen!

oXygen XML Author

Dies ist ein kostenloser, quelloffener DITA-kompatibler XML-Editor mit vielen treuen Benutzern und guten Bewertungen. DITA (Document Information Typing Architecture) ist ein offener Standard für das Verfassen und Veröffentlichen von Dokumenten, der langsam Einzug in das technische Dokumentenmanagement gehalten hat. Ganz einfach, weil er die Abhängigkeit der Bearbeitung von Inhalten von einem bestimmten Tool aufhebt. Wenn Sie eine DITA-konforme Online-Dokumentation (eine Reihe von XML-Dateien) erstellen, können Sie diese in Zukunft mit jedem anderen DITA-konformen Tool bearbeiten und pflegen!
Da die DITA-Spezifikationen ein Bereich sind, der besondere Aufmerksamkeit erfordert, möchte ich mir das für einen anderen Artikel aufheben.
Tipp des Autors: Es genügt zu sagen, dass die oXygen-Suite eine brauchbare Alternative zu dem sehr beliebten, aber unerschwinglichen Adobe Framemaker ist. oXygen Author wird in der Regel in Kombination mit oXygen Developer verwendet.
So, das ist alles, was Sie an Software für die technische Redaktion in der Phase „Dokumentinformationen“ brauchen werden. Im nächsten und letzten Teil geht es um die Phase „Veröffentlichen der Informationen“.
Um einige großartige Tipps für die technische Redaktion zu erhalten und um sicherzustellen, dass Sie keine Updates zu unseren Tools für die technische Redaktion verpassen, abonnieren Sie unseren Blog.
Gefällt es Ihnen? Setzen Sie ein Lesezeichen für den Artikel oder teilen Sie ihn mit Ihren Freunden und Kollegen!

Whatfix ist ein innovatives Unternehmen im Bereich der technischen Schreibwerkzeuge, das die Idee langwieriger, kontinuierlicher schriftlicher Inhalte auf den Kopf stellt. Unsere interaktiven Leitfäden helfen Ihnen, produktiver zu werden, indem sie Ihnen einen schnellen und effektiven Weg zur Erstellung technischer Dokumentation bieten. Lesen Sie in diesem Artikel mehr darüber, wie Whatfix bei der technischen Dokumentation hilft.