Sind Sie ein angehender technischer Redakteur, der gerade erst anfangen will, aber nicht weiß, welche Werkzeuge er für die Dokumentation seiner Texte verwenden soll? Dann sind Sie hier genau richtig!
Zuallererst sollten wir verstehen, was genau technische Dokumentation ist
Man muss seinen Prozess dokumentieren und daher wird ein technisches Dokument als einer der wichtigsten Faktoren betrachtet, die zum Erfolg eines Softwareprojekts beitragen.
Ein technisches Dokument sollte keinen Doktortitel erfordern, um es zu verstehen. Einfacher ausgedrückt und in Bezug auf die Technik bezieht sich die technische Dokumentation auf jede Art von Dokumentation, die die Handhabung, Funktionalität und Architektur eines technischen Produkts oder eines anderen Produkts beschreibt, das sich in der Entwicklung oder im Einsatz befindet.
Dokumentation kann von einem einseitigen Anforderungsblatt bis hin zu einem dicken Referenzhandbuch reichen, das ein neues Open-Source-Framework dokumentiert.
Heute sind Dokumentationen für Apps, APIs, SDKs und sogar die meisten Hardwareprodukte online verfügbar.
Ich habe die besten Tools für technische Dokumentation zusammen mit Links aufgelistet, um ein Gefühl für sie zu bekommen und sie besser zu verstehen, also lasst uns anfangen, oder?
HelpNDoc ist ein einfach zu bedienendes und dennoch leistungsfähiges Autorentool, das vielseitig einsetzbar ist und verschiedene Dokumentationsformate aus einer einzigen Quelle generieren kann.
HelpNDoc bietet alle notwendigen Werkzeuge, um komplette Hilfedateien, Handbücher und Dokumentationen in einer benutzerfreundlichen und sehr einfach zu bedienenden Umgebung zu schreiben.
Es kann Standard-Windows-CHM-Hilfedateien, WEB-basierte Dokumentation, iPhone-spezifische Websites sowie druckbare PDF- und Word-Dokumente generieren.
Features
– HelpNDoc ermöglicht es dem Autor, einen einzigen Quelltext zu erstellen, den es dann in eine Reihe von Zielformaten wie HTML-Hilfe, PDF, RTF, DocX, Qt-Hilfe und HTML-Dokumentation sowie EPUB und Amazon Kindle-kompatible E-Books konvertiert.
– Es hat auch die Fähigkeit, Code für die Programmiersprachen C++, Delphi, Fortran, Pascal und Visual Basic zu generieren, um die generierten CHM-Hilfedateien in die zu entwickelnde Anwendung zu integrieren.
– Ab Version 4 verfügt HelpNDoc über einen Projektanalysator, der das Layout des Dokuments verfolgen, Statistiken bereitstellen und potenzielle Probleme wie defekte Links oder Probleme mit Medienelementen identifizieren kann.
- HelpNDoc kann auch zur Veröffentlichung mobiler Websites verwendet werden, wobei das Inhaltsverzeichnis als Navigationsmenü, der Inhalt der Themen mit Navigationsschaltflächen, das Schlüsselwortindexmenü, eine eingebaute Suchmaschine und mobilspezifische Benutzeroberflächenelemente verwendet werden.
https://www.helpndoc.com/
#2 ClickHelp
Wenn Sie ein Dokumentationstool mit einer Vielzahl von Funktionen benötigen, dann ist ClickHelp das Richtige für Sie. ClickHelp ist ein modernes, browserbasiertes Dokumentationswerkzeug, das einfach einzurichten und zu benutzen ist. Es erfordert keine Installation, läuft in einem Webbrowser und unterstützt mehrere Plattformen: Mac OS, Windows und Linux, was es einfach macht, Ihre Dokumentation von jedem Ort der Welt aus zu verfassen.
Softwareunternehmen auf der ganzen Welt nutzen ClickHelp, um Online-Benutzerhandbücher, Wissensdatenbanken, Hilfedateien, FAQs und Tutorials zu erstellen und sie sofort in ihrem Portal zu veröffentlichen.
Merkmale
-Tägliche Backups- ClickHelp bietet tägliche Backups, damit Sie Ihre Daten sicher aufbewahren können
-Fortgeschrittene Analysen- ClickHelp verfügt über eigene integrierte Analysen, die Ihnen helfen, die aktuelle Situation zu analysieren und Ihren Dokumentationsprozess auch im Voraus zu planen.
-Menschlich lesbare Projekt-URLs- Eine Funktion, die nicht nur für Menschen, sondern auch für Suchmaschinen nützlich ist. Diese Funktion hilft bei der Suchmaschinenoptimierung Ihrer Dokumentation
-Schaltflächen für die Freigabe in sozialen Medien- Teilen Sie Ihre Dokumentation ganz einfach in verschiedenen sozialen Medien.
-Überprüfungsnotizen für Themen- Die Überprüfung ist eine Phase im Dokumentationserstellungsprozess, die kein Team auslassen kann. ClickHelp bietet nicht nur die Funktion für Überprüfungsnotizen, sondern auch eine spezielle Prüferrolle.
-Mächtiger Themeneditor- Jeder technische Redakteur mag einen guten Texteditor, ClickHelp bietet Word-ähnliche Funktionen und mehr, um Ihnen eine komfortable Arbeitsumgebung zu bieten.
- Integrationen- ClickHelp hat beeindruckende Optionen für Integrationen wie: Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com, etc.
https://clickhelp.com/
#3 Whatfix
Wollen Sie eine interaktive Anleitung auf Ihrer Plattform erstellen? Whatfix ist das richtige Tool für Sie.
Whatfix ist eine Digital Adoption Platform, die Unternehmen beim Onboarding, der Schulung und dem Support ihrer Anwendungsnutzer unterstützt.
Whatfix ermöglicht die Erstellung und Bereitstellung kontextbezogener und benutzerdefinierter Inhalte in Form von Abläufen, Hilfetipps, Videos, Links und Text als In-App-Erlebnis
Whatfix kann zur Erstellung von Inhalten für jede webbasierte Unternehmensanwendung wie Salesforce, SAP SuccessFactors, Oracle HCM Cloud usw. sowie für benutzerdefinierte Webanwendungen und für Websites mit Kundenkontakt verwendet werden.
Darüber hinaus unterstützt Whatfix sowohl den Cloud- als auch den Self-Hosting-Modus.
Merkmale
-Multi-Browser-Kompatibilität API
-Interaktive Benutzerhandbücher
-Self-Hosting
-Datenanalyse
-Benutzerverfolgung
-Mehrere Handbuchformate, einschließlich Videos, Grafiken, Bilder und Texte.
-Anpassbare Benutzeroberfläche
#4 ProcessStreet
ProcessStreet ist die einfachste Möglichkeit, wiederkehrende Arbeitsabläufe für Ihr Team zu verwalten. Außerdem hilft es Ihnen, Ihrem Team schnell Checklisten-Workflows zuzuweisen.
ProcessStreet hat eine einfache Schnittstelle, mit der Sie in Sekundenschnelle ein strukturiertes Dokument erstellen können. Darüber hinaus können Sie die Aktivitäten über das Dashboard verfolgen und werden benachrichtigt, wenn Aufgaben erledigt sind.
ProcessStreet ist das Zuhause für die Prozessdokumente Ihres Teams, und dank der intuitiven Tastenkombinationen und der Drag-and-Drop-Funktion ist es für jeden leicht zu bedienen.
Funktionen
-Bedingte Logik- Verwenden Sie bedingte Logik, um wirklich dynamische Checklisten mit Wenn/Dann-Logik zu erstellen, die sich an die sich ändernden Anforderungen Ihres Teams anpassen.
-Verwenden Sie Formulare zur Erfassung strukturierter Daten- Verwenden Sie Formulare zur Erfassung strukturierter Daten in Ihren Checklisten. Geben Sie Daten manuell ein oder lassen Sie sie an und von den von Ihnen gewählten Anwendungen senden.
-Regelbasierter Workflow
-Collaborative Workspace
Zusammenfassend
Es gibt verschiedene Software-Tools für unterschiedliche Arten der Technischen Dokumentation, für welches Sie sich entscheiden, hängt von Ihrer Zielgruppe ab. Sie müssen ein Gefühl für die Software bekommen, die Sie am meisten anspricht, und einfach loslegen. Wenn Sie erst einmal angefangen haben, können Sie immer noch entscheiden, welche Software für Sie ideal ist.