Welche Software-Dokumentationstools gibt es, und welches passt zu Ihrem Anwendungsfall? Wir vergleichen zehn Lösungen für Benutzerhandbücher und Schritt-für-Schritt-Anleitungen, von der schlanken Desktop-Lösung bis zur Wissensdatenbank.
Bei FlowShare haben wir täglich mit Unternehmen aller Größen und aus den unterschiedlichsten Branchen zu tun.
Viele dieser Unternehmen, vor allem KMUs (kleine und mittelständische Unternehmen), haben eine Herausforderung gemeinsam: die Notwendigkeit, Wissen über Best Practices und digitale Prozesse weitergeben zu müssen. Zu diesem Zweck erstellen die Unternehmen Dokumentationen oder Schritt-für-Schritt-Anleitungen – allerdings häufig ohne Hilfsmittel. IT-Administratoren oder Anwendungsmanager erstellen manuell Software-Dokumentationen und Schritt-für-Schritt-Anleitungen für Kollegen, Teammitglieder oder Kunden. Sie tun dies zum Beispiel, um Kunden die Funktionsweise von Software zu erläutern, ihren IT-Support zu optimieren oder neue Mitarbeiter einzuarbeiten.
Wer selbst schon einmal manuell eine Dokumentation mit Screenshots erstellt hat, weiß: Das ist gar nicht so einfach. Screenshots anfertigen, diese zusammensetzen in einem Word- oder PowerPoint-Dokument, Texte und Beschreibungen hinzufügen. Einen Arbeitsvorgang umfassend und verständlich zusammenzufassen, ist ohne ein passendes Tool extrem aufwändig. Die Erstellung kostet viel Zeit und Nerven und häufig ist das Ergebnis enttäuschend: Nicht einheitlich und übersichtlich, sondern durcheinander und wenig hilfreich. Kommt Ihnen das bekannt vor?
Wenn ja, sind Sie definitiv nicht allein, und wir sind hier, um zu helfen.
Selbst wenn Sie noch nie zuvor Prozesse dokumentiert haben.
Was ist Software-(Benutzer-)Dokumentation?
Software-Dokumentation ist das Erfassen digitaler Prozesse, die dazu dienen können, Software oder Softwarebereiche zu erklären. Es wird zwischen verschiedenen Arten der Dokumentation unterschieden, die meist je nach Zielgruppe variieren. Letztere reicht von Software-Architekten und Entwicklern bis hin zu Kunden und Endanwendern.
Benutzerdokumentation gibt es in vielen Formen, von detaillierten Benutzerhandbüchern über Microlearning-„Nuggets“ bis hin zu kontextsensitiven Hilfe-Systemen (Performance Support System, Digital Adoption Platform). Die Wahl des Formats hängt primär davon ab, wie komplex das vermittelte Anwenderwissen ist und wie viel Geschick die Endanwender für den erfolgreichen Umgang mit der Software benötigen. Generell gilt: Anleitungen sollten so lang wie nötig und so kurz wie möglich gehalten werden.
In einer Geschäftswelt, in der Software immer vielfältiger und komplexer wird und ständig verändert und weiterentwickelt wird, ist es sinnvoll, notwendige Software-Grundlagen in formalen Lernsettings periodisch aufzufrischen und durch dezentrale Lernmechanismen zu ergänzen.
Welche verschiedenen Arten der Software-Dokumentation gibt es?
Um zu verstehen, welche Tools am besten für Ihre Bedürfnisse geeignet sind, sollten Sie prüfen, welche Art von Dokumentation Sie tatsächlich benötigen. Es gibt verschiedene Arten für unterschiedliche Zwecke.
Wenn Sie bereits Bescheid wissen und die Tools kaum erwarten können – überspringen Sie den ersten Teil und fangen Sie direkt hier an.
Technische Dokumentation
Die technische Dokumentation ist für Entwickler und Tester entscheidend, um die Systemarchitektur, den Code und das Zusammenspiel der verschiedenen Systemteile zu verstehen. Sie kann unter anderem Systemspezifikationen, Architekturdiagramme, API-Dokumentationen, Datenbankschemata und Code-Kommentare umfassen.
Beispiel: In einem komplexen Softwareprojekt könnte die technische Dokumentation Architekturdiagramme enthalten, die zeigen, wie das System strukturiert ist und wie verschiedene Komponenten interagieren. Beispielsweise wäre in einer Microservices-Architektur ein Diagramm, das die Kommunikation der verschiedenen Dienste zeigt, zusammen mit einer API-Dokumentation, die Endpunkte, Anfrage-/Antwortformate und Authentifizierungsmechanismen detailliert beschreibt, von entscheidender Bedeutung. Diese Dokumentation ist unerlässlich für das Onboarding neuer Entwickler oder bei der Planung von System-Upgrades.
Sie wird häufig von technischen Redakteuren, Systemarchitekten oder Entwicklern erstellt, die über tiefgehende technische Kenntnisse der Software verfügen.
Benutzerdokumentation
Die Benutzerdokumentation zielt darauf ab, Endanwendern zu helfen, die Software effizient zu verstehen und zu bedienen. Insbesondere bei ERP-Software (Enterprise Resource Planning), die oft an die spezifischen Bedürfnisse eines Unternehmens angepasst wird, ist die Benutzerdokumentation eine kritische Ressource. Diese kann vom Softwarehersteller oder intern durch Rollen wie First-Level-Support, Applikationsmanager oder sogar User Experience Designer erstellt werden, die ein gutes Verständnis der Benutzeroberfläche und der Funktionalitäten haben.
Beispiel: Angenommen, ein Fertigungsunternehmen hat eine angepasste ERP-Software zur Verwaltung seiner Abläufe. Die Benutzerdokumentation, die wahrscheinlich intern von Applikationsmanagern erstellt wurde, könnte Handbücher zur Eingabe und Verfolgung von Aufträgen, Tutorials zur Erstellung und Interpretation verschiedener Berichte sowie FAQs zu häufigen Problemen wie der Korrektur von Dateneingabefehlern oder der Fehlerbehebung bei Zugriffsproblemen enthalten. Diese Dokumentation wäre für die Einarbeitung neuer Mitarbeiter und als Referenz für bestehende Mitarbeiter unverzichtbar.
Prozessdokumentation.
Prozessdokumentation im geschäftlichen Umfeld kann das Dokumentieren von Prozessen umfassen, die innerhalb verschiedener Anwendungen ausgeführt werden, um Konsistenz, Genauigkeit und Compliance zu gewährleisten.
Beispiel: In einer Finanzabteilung kann es Prozesse geben, die eine Dateneingabe in einer Buchhaltungssoftware, gefolgt von einer Genehmigung in einer Workflow-Anwendung und anschließendem Reporting mit einem Business-Intelligence-Tool beinhalten. Die Dokumentation dieser Prozesse kann die Erstellung von Schritt-für-Schritt-Anleitungen umfassen, die erklären, wie Daten eingegeben, genehmigt und gemeldet werden sollen. So wird sichergestellt, dass alle Mitarbeiter die korrekten Verfahren verstehen, was wiederum dazu beiträgt, die Datengenauigkeit und die Einhaltung von Finanzkontrollen zu wahren.
Qualitätssicherungs-Dokumentation
Diese Art der Dokumentation stellt sicher, dass die Software die erforderlichen Qualitätsstandards und Compliance-Vorgaben erfüllt. Sie umfasst Compliance-Dokumente, Qualitätschecklisten und Audit-Berichte.
Beispiel: In einem Projekt, das die Einhaltung der ISO 27001-Normen erfordert, würde ein Compliance-Dokument erstellt, das die durchgeführten Prüfungen, die erfüllten Standards sowie etwaige Abweichungen nebst Korrekturmaßnahmen aufzeigt. Diese Dokumentation ist für Audit-Zwecke und zur Aufrechterhaltung der Qualität und Compliance der Software unerlässlich.
Projektdokumentation
Die Projektdokumentation bietet einen Überblick über die Projektziele, den Umfang, die Zeitpläne und die Ressourcen. Sie trägt dazu bei, dass alle Beteiligten die Ziele und Anforderungen des Projekts verstehen. Projektleiter oder Projektkoordinatoren sind häufig für diese Dokumentation verantwortlich und stellen sicher, dass Projektziele, Zeitpläne und Ressourcen gut dokumentiert und kommuniziert werden.
Beispiel: Ein Projektplan für die Entwicklung einer neuen mobilen Anwendung könnte die Projektziele, Meilensteine, Zeitpläne, Ressourcenzuweisungen, Risikomanagementpläne und Kommunikationspläne enthalten. Diese Dokumentation ist entscheidend für das Projektmanagement, die Kommunikation mit Stakeholdern und um sicherzustellen, dass das Projekt auf Kurs bleibt.
Interaktive Leitfäden und Self-Service-Wissensdatenbanken
Dies sind moderne Arten der Dokumentation, die durch Tools wie Screensteps ermöglicht werden. Sie erlauben die Erstellung interaktiver Leitfäden und zentraler Repositories für Schulungsinhalte, die oft von Kundensupport-Spezialisten oder Dokumentationsspezialisten erstellt werden, um den Nutzern Ressourcen zur Selbsthilfe zur Verfügung zu stellen.
Beispiel: Ein Unternehmen könnte eine Self-Service-Wissensdatenbank für seine CRM-Software erstellen, die interaktive Anleitungen zum Anlegen neuer Kontakte, zur Verwaltung von Sales-Pipelines oder zur Erstellung von Berichten enthält. Dieses Repository könnte Artikel, FAQs und Videos enthalten, die es den Nutzern ermöglichen, eigenständig Lösungen zu finden und die Belastung des Kundensupports zu reduzieren.
Standard Operating Procedures (SOPs):
SOPs sind formale, schriftliche Anweisungen, um Einheitlichkeit bei der Durchführung spezifischer Aufgaben zu erreichen. Sie skizzieren Routineaktivitäten, oft Schritt für Schritt, und stellen sicher, dass Prozesse konsistent ausgeführt werden, um Qualität und Compliance zu wahren. Typischerweise werden SOPs von Prozessmanagern, Qualitätssicherungsmanagern oder Betriebsleitern erstellt, die über ein gründliches Verständnis der Geschäftsprozesse verfügen.
Beispiel: Eine SOP könnte die Schritte für die Bearbeitung von Kundenretouren in einer Einzelhandels-Management-Software detailliert beschreiben, um sicherzustellen, dass alle Mitarbeiter Retouren auf konsistente und regelkonforme Weise bearbeiten.
Team-Benutzerhandbücher:
Team-Benutzerhandbücher sind auf die spezifischen Bedürfnisse und Workflows eines bestimmten Teams innerhalb einer Organisation zugeschnitten. Sie bieten Anweisungen, Richtlinien und Protokolle für die Nutzung von Softwareanwendungen, die für die Aufgaben des Teams relevant sind. Diese Handbücher können von Applikationsmanagern, Teamleitern oder designierten Dokumentationsspezialisten innerhalb des Teams erstellt werden. In einigen Fällen kann auch eine gemeinschaftliche Anstrengung der Teammitglieder, die die Software täglich nutzen, zur Erstellung und Pflege dieser Dokumentation beitragen.
Beispiel: Ein Benutzerhandbuch für das Vertriebsteam kann Richtlinien zur Nutzung der CRM-Software enthalten, um Kontakte zu protokollieren, Leads zu verfolgen und Sales-Pipelines zu verwalten.
Automatisierte How-To-Anleitungen
Tools wie FlowShare, Scribe oder Tango automatisieren die Erstellung von How-To-Anleitungen, indem sie Prozesse während der Ausführung erfassen und Schritt-für-Schritt-Anleitungen generieren.
Beispiel: Ein Team, das FlowShare verwendet, um den Prozess der Erstellung monatlicher Verkaufsberichte in einer bestimmten Software zu dokumentieren, kann die Aufgabe ausführen, während FlowShare jeden Schritt erfasst und automatisch eine detaillierte Anleitung mit Screenshots, Anmerkungen und Textbeschreibungen generiert. Diese Anleitung kann dann in mehreren Formaten mit anderen Teammitgliedern geteilt werden, was die Konsistenz bei der Aufgabenausführung gewährleistet und es neuen Teammitgliedern erleichtert, den Prozess zu erlernen.
Obwohl diese Anleitungen automatisch generiert werden können, erfordern sie möglicherweise eine Überprüfung oder Bearbeitung durch Fachexperten.
Warum die Wahl des richtigen Software-Dokumentationstools für Ihr Unternehmen entscheidend ist
Wir haben noch niemanden getroffen, der gerne (per Hand) dokumentiert – und trotzdem sind die Dokumentationen so wichtig und hilfreich im Alltag von Unternehmen, um Wissen und Informationen weiterzugeben. Sie ermöglichen Endnutzern, erfolgreich mit Software zu arbeiten, optimieren den IT-Support, standardisieren interne Prozesse und geben Experten und Key-Usern mehr Zeit für wertvolle Aufgaben.
Genau dafür gibt es Lösungen für schnelle und einfache Softwaredokumentation, sowie hochwertige User Manuals. Auf dem Markt gibt es zahlreiche Dokumentationstools, die viel Zeit und Aufwand beim Dokumentieren ersparen. Die daraus resultierenden Dokumentationen und Anleitungen richten sich an Endnutzer (nicht an Programmierer – in dem Fall suchen Sie nach “Entwicklerdokumentation” oder “Systemdokumentation”) und haben oft eine hohe Qualität. Wir haben uns verschiedene Tools zur Prozessdokumentation angeschaut und stellen Ihnen einige davon vor. Mit diesen Informationen können Sie eine fundierte Entscheidung darüber treffen, welches das beste Software-Dokumentationstool für Ihren spezifischen Anwendungsfall und Ihre betrieblichen Anforderungen ist.
Top-10-Liste der besten Software-Dokumentationstools für User Guides
1. FlowShare: Die intelligente Dokumentationslösung
FlowShare ist ein leistungsstarkes Software-Dokumentationswerkzeug, mit dem Sie automatisch Schritt-für-Schritt-Anleitungen erstellen können:
Führen Sie den Vorgang einfach in einer beliebigen Anwendung durch, die Sie als Anleitung auf Ihrem Computer festhalten möchten. ie können jede Software oder Anwendung dokumentieren, die Sie wollen, im Browser oder auf dem Desktop, sogar komplexe oder benutzerdefinierte Anwendungen wie ERP-Systeme, solange sie auf Windows laufen – FlowShare erfasst sie alle.
FlowShare erfasst und speichert automatisch jeden Klick. Alle Schritte werden dann in einem Dokument mit Screenshot, Pfeil und kurzer automatisch erstellten Text-Beschreibung zusammengefasst. Sie können Ihre Benutzerdokumentation im Nachhinein mit Funktionen wie Blurring (unkenntlich Machen), Zuschneiden von Bereichen und dem Hinzufügen zusätzlicher Anmerkungen bearbeiten.
Wichtige Export- und Sharing-Funktionen:
Nachdem Sie Ihren Prozess erfasst und bearbeitet haben, können Sie die Dokumentation entweder durch lokalen Export oder online – auf Ihrem Kundenportal oder über eine Integration – weitergeben. FlowShare bietet verschiedene Export-Formate wie PDF, Microsoft Word, PowerPoint, HTML, xAPI, SCORM oder OpenRPA an. Außerdem ermöglicht es Ihnen, das Design anzupassen oder eine benutzerdefinierte Word- oder PowerPoint-Vorlage zu verwenden, die zu Ihrem Branding passt.
Neben statischen Formaten können Sie auch interaktive Demos erstellen oder wenn Sie Ihre Dokumentation nicht nur lokal speichern wollen, können Sie eine der direkten Integrationen nutzen, um die Dokumentationen direkt in Wissensdatenbanken oder E-Learning-Plattformen wie z.B. Confluence, WordPress, Avendoo zu veröffentlichen.
FlowShare ist auf Englisch und Deutsch verfügbar und verfügt über eine Multilanguage-Funktion, die die Übersetzung in über 30 Sprachen ermöglicht.
Due to the high degree of automation and the simple operation, the time saving with FlowShare is enormous:
Aufgrund des hohen Automatisierungsgrades und der einfachen Bedienung ist die Zeitersparnis mit FlowShare enorm: Die Software läuft auf Windows und ist ab 35 € im Monat verfügbar. Um auszuprobieren, ob FlowShare zu Ihren Bedürfnissen passt, können Sie die Software kostenlos und unverbindlich testen.
2. iorad: Das Online-Dokumentationstool
Iorad kann die im Browser getätigten Klicks aufzeichnen und in einer interaktiven Schritt-für-Schritt-Anleitung zusammenführen.
Neben der Browsererweiterung gibt es auch ein Desktop-Erfassungstool zum Download. Beim Dokumentieren werden die Screenshots und Texte automatisch von iorad generiert. Außerdem können die Nutzer sie bei Bedarf nachträglich bearbeiten.
Die fertigen Tutorials werden in der Cloud gespeichert, die Nutzer können sie per Link teilen, auf ihrer Website veröffentlichen oder in ihre favorisierte Lernplattform einbetten. Darüber hinaus hat iorad „The square“ geschaffen, eine von der Community betriebene Plattform, auf der Menschen mit Hilfe von iorad anwendungsbezogene Fragen stellen und beantworten können. Iorad bietet ein schnelles Software-Dokumentationswerkzeug, kann aber mit all seinen anderen Funktionen eher als eine digitale Implementierungsplattform als eine reine Dokumentationslösung betrachtet werden. Mit Preisen ab 200 $ pro Monat für eine Lizenz ist die Software eher ein Premiumprodukt. Iorad bietet jedoch Rabatte für gemeinnützige Organisationen und Bildungseinrichtungen an. Die Software ist verfügbar unter https://www.iorad.com/.
Quelle: iorad.com
3. Tango: Browser-basierte Erfassung mit Chrome-Erweiterung I
Im Gegensatz zu FlowShare oder anderen Desktop-Tools ist Tango eine Chrome-Erweiterung und funktioniert daher direkt im Browser als Online-Dokumentationstool. Tango wurde speziell für die Erfassung webbasierter Produkte im Chrome- oder Edge-Browser entwickelt, doch die Pro-Version umfasst auch die Erfassung systemeigener Apps mit der Desktop-App der Software.
Wie FlowShare erstellt auch Tango für jeden Klick automatisch einen Schritt mit Text und Bild.
Bei unseren Tests haben wir jedoch festgestellt, dass Tango nicht in der Lage ist, automatisch Textdaten zu extrahieren, um die Beschreibungen für die erstellte Anleitung zu generieren. Wir haben es mit Microsoft Word getestet, einer Standardanwendung, mit der andere Dokumentationstools keine Probleme haben. Während es für die webbasierte Dokumentation hervorragend geeignet ist, schneidet die Desktop-Version weniger gut ab. Das sollten Sie bei der Auswahl des richtigen Werkzeugs bedenken.
Die Standard-Erfassungssprache von Tango ist Englisch, Texte in anderen Sprachen müssen manuell übersetzt werden.
Die Nutzer können die fertigen Guides individuell gestalten, zum Beispiel mit ihrem Logo, Anmerkungen oder Zeichnungen. Anschließend speichern sie alle Arbeitsabläufe als bearbeitbare Dateien in ihrem Tango Workspace. Das bedeutet, dass die Daten in der Cloud gespeichert werden und nicht lokal gespeichert werden können. Die Nutzer können die Anleitungen per Link weitergeben oder in eine Wissensdatenbank oder eine Webseite einbetten. Tango gibt es in einer kostenlosen Version. Für erweiterte Funktionen können Sie die Pro-Version für 16 $ pro Monat und Benutzer unter https://www.tango.us erwerben. Tango bietet Rabatte für gemeinnützige Organisationen und Studierende.
Quelle: www.tango.us
4. Scribe: Chrome-Erweiterung II für automatisierte Guides
Scribe ist ursprünglich auch eine Chrome-Erweiterung zur automatischen Erstellung von Anleitungen für digitale Arbeitsprozesse.
Ähnlich wie Tango bietet auch Scribe eine Desktop-Version seiner Software an, sowohl für Mac als auch für Windows.
Sobald ein Workflow erfasst wurde, bietet Scribe mehrere Bearbeitungsoptionen über einen WYSIWYG-Editor.
Dazu gehören unter anderem das Weichzeichnen, Löschen, Verschieben, Kopieren von Schritten und eine Anpassung der Anleitung an Ihre Marke. Alle mit Scribe generierten Daten werden in einem Workspace in der Scribe-Cloud gespeichert, eine lokale Datenspeicherung ist nicht möglich.
Anwender können ihre Anleitungen per E-Mail weitergeben, sie in ihr Wiki einbetten, z.B. auf Confluence, Microsoft Teams oder HelpScout, oder sie als PDF exportieren. Scribe hat eine kostenlose Basisversion, die Pro-Version beginnt bei 23 $ pro Person und Monat und kann hier erworben werden: https://scribehow.com. Das Unternehmen bietet Rabatte für gemeinnützige Organisationen und Bildungseinrichtungen an.
Quelle: scribehow.com
5. Snagit: Bildschirmaufzeichnung meistern
Snagit ist eine Bildschirmaufzeichnungssoftware von Techsmith.
Damit können Sie ganz einfach Screenshots erstellen, einschließlich horizontaler und vertikaler Scrolls. Anschließend können die aufgenommenen Screenshots mit einer Vielzahl von Möglichkeiten bearbeitet werden. So können die Nutzer beispielsweise Pfeile, Formen und Schritte auf den Screenshots hinzufügen. Darüber hinaus bietet Snagit eine Videoaufnahmefunktion und verschiedene Layoutvorlagen für das Erstellen von Anleitungen.
Die wahren Stärken der Software liegen in der Bildbearbeitung und -erfassung. Snagit bietet zwar Vorlagen, die auf die aufgenommenen Bilder angewendet werden können, erstellt aber nicht automatisch Textbeschreibungen. Snagit bietet zwar eine Vielzahl von Exportformaten und Möglichkeiten, Vorlagen auf die Bilder anzuwenden, aber die Kernfunktionalität besteht nicht in der Erstellung einer kompletten Softwaredokumentation. Stattdessen liegt diese vielmehr darin, die Bilder für eine Softwaredokumentation zu erstellen und das Dokument an anderer Stelle, zum Beispiel in Microsoft Word, fertigzustellen. Zumindest nach unseren Erfahrungen und denen unserer Kunden.
Die Benutzer von Snagit können ein Video ihres Gesichts in die Bildschirmaufnahme einfügen, um die Schritte des Benutzerhandbuchs zu erläutern und die Erläuterungen persönlicher zu gestalten. Die Dokumentation kann über eine kurze URL oder über die Cloud mit anderen Anwendern geteilt werden.
Snagit ist ab 68,21 € für eine Einzellizenz unter https://www.techsmith.com/ erhältlich.
Quelle: www.techsmith.com/screen-capture
6. Folge: Die Wahl der technischen Redaktion
Folge ist eine Desktop-Anwendung, die für Windows und Mac verfügbar ist, d. h. Sie können alle Ihre Daten und Prozesse übernehmen.
Ähnlich wie bei FlowShare können Sie mit Folge einen Arbeitsablauf festhalten, indem Sie für jeden Klick einen Screenshot machen. Außerdem können Sie damit auch (wenn gewünscht) nur einen bestimmten Bereich des Bildschirms erfassen. Nachdem Sie die Klicks aufgezeichnet haben, können Sie die Schritte in Folge bearbeiten, z. B. Teile des Bildschirms weichzeichnen oder bestimmte Bereiche hervorheben. Wenn Sie eine schriftliche Erklärung zu den Screenshots wünschen, müssen Sie die Beschreibung bei den jeweiligen Schritten hinzufügen.
Nach der Bearbeitung können die Anwender ihre erstellte Dokumentation exportieren. Folge bietet den Export als PDF, HTML, Powerpoint, Word, JSON und Markdown an. Die Software enthält verschiedene Exportvorlagen und Schriftarten.
Folge scheint eine beliebte Wahl für technische Dokumentation zu sein, weil es eine Vielzahl von Bearbeitungswerkzeugen und Exportformaten wie Markdown bietet, die es zu einer großartigen Lösung für technische Redakteure machen.
Diejenigen, die sich noch an Clarify für Mac erinnern und es vermissen (das eingestellt wurde, da sich die Entwickler auf ihre vielseitigere Lösung Screensteps konzentrierten), werden mehr als froh sein, dass es Folge gibt.
Wenn Sie jedoch viele Prozesse in großem Umfang erfassen müssen, ohne über die Kenntnisse und Fähigkeiten eines technischen Redakteurs zu verfügen, und auch das Schreiben der Textbeschreibungen automatisieren möchten, sind Sie vielleicht mit einer anderen Lösung besser bedient.
Sie können Folge kostenlos ausprobieren und fünf Guides exportieren.
Um eine unbegrenzte Anzahl von Anleitungen zu exportieren, können Sie die Software für 69 € (persönliche Nutzung) bzw. 130 € (kommerzielle Nutzung) unter https://folge.me erwerben. Folge bietet einen Rabatt für akademische Einrichtungen an.
Quelle: folge.me
7. Screensteps: Integration der Wissensdatenbank in die Dokumentation
Screensteps ist eigentlich eine Wissensdatenbank-Software, aber ihre Wurzeln liegen in der Software-Dokumentation. Es handelt sich um ein Tool zur Erstellung strukturierter Anleitungen mit Screenshots und zur Organisation dieser Anleitungen in einer Wissensdatenbank.
Das Tool ermöglicht die Aufnahme von Bildschirminhalten sowie verschiedene nachträgliche Bearbeitungsoptionen wie das Hinzufügen von Pfeilen, Text, Videos, GIFs und zusammenklappbaren Kapiteln. Screensteps bietet viele Add-ons, wie Kurse oder eine Browsererweiterung für kontextbezogene Hilfe.
Mit Screensteps können Sie alle von Ihnen erstellten Workflows in einer Online-Wissensdatenbank mit Analysetools sammeln und organisieren. Die Mitarbeiter können diese Wissensdatenbank selbst durchsuchen oder eine Suchmaschine verwenden, um eine gewünschte Arbeitsanweisung zu finden. Screensteps ermöglicht es Ihnen, verschiedene Formen von Software-Dokumentation zu erstellen, z. B. für Endbenutzer, und diese in einer eigenen Wissensdatenbank (öffentlich und privat) bereitzustellen.
Screensteps kann ab 239 € pro Monat für 25 aktive Nutzer erworben werden. Mhr Information unter http://www.screensteps.com.
Quelle: www.screensteps.com
8. Stepsy: Das überarbeitete Tool aus dem Stepshot-Vermächtnis
Anwender, die schon länger Handbücher erstellen, erinnern sich vielleicht noch an das Tool „Stepshot“.
Stepshot konnte per Mausklick Screenshots machen und sie zu einer Schritt-für-Schritt-Anleitung zusammensetzen. 2019 wurde Stepshot von UiPath übernommen und konzentrierte sich von da an mehr auf Robotic Process Automation (RPA). Das alte Produkt Stepshot wurde nur noch bis 2020 unterstützt.
Jetzt ist der Stepshot-Gründer zurück, diesmal auch mit einer browserbasierten Lösung: Stepsy ermöglicht es, digitale Prozesse automatisch zu erfassen und die erstellten Anleitungen zum Beispiel mit Kollegen zu teilen. Das Tool ist beispielsweise für Prozesse in Google Drive ehr gut geeignet. Fertige Anleitungen können in PDF oder Word exportiert werden, sie können in GDrive geteilt werden oder ihre Bilder können in einer Zip-Datei oder als statische HTML-Seite gespeichert werden. Stepsy hat eine kostenlose Version und kostet 9 $ pro Monat in der Pro-Version, die hier erworben werden kann: https://stepsy.co.
Quelle: stepsy.co
9. Greenshot: Der (fast kostenlose) Klassiker
Greenshot mag auf den ersten Blick etwas altmodisch wirken, erfreut sich aber bei einigen langjährigen Nutzern immer noch großer Beliebtheit.
Es handelt sich um eine nützliche kostenlose Dokumentationssoftware (für Windows, Mac-Benutzer zahlen die geringe Gebühr von 1,99 $), mit der Sie einfache Screenshots des gesamten Bildschirms oder ausgewählter Bereiche erstellen können. Die Screenshots können im Editor mit grafischen Elementen oder Beschriftungen ergänzt und anschließend gespeichert werden.
Greenshot kann nicht die gesamte Software-Dokumentation oder das Benutzerhandbuch für Sie erstellen – aber es kann Ihnen helfen, die Bilder und Screenshots dafür zu erstellen. Die Hauptarbeit bei dem Erstellen der Anleitung, das Erstellen eines Dokuments, das Schreibens der Textbeschreibungen und das Layout müssen Sie hier selbst übernehmen. Wenn Sie mit Word sehr schnell sind und das Aussehen Ihres Dokuments möglichst flexibel gestalten wollen – und das mit einem kostenlosen Tool – dann ist Greenshot vielleicht die richtige Wahl für Sie.
Die letzte verfügbare Version von Greenshot stammt jedoch aus dem Jahr 2017, so dass das Tool danach nicht mehr weiterentwickelt wurde.
Insgesamt ist Greenshot ein einfaches Tool zum Erstellen und Bearbeiten von Screenshots, das für Windows-Benutzer kostenlos und für Mac-Benutzer für 1,99 $ erhältlich ist.
Wenn Sie sich für Greenshot entscheiden, sollten Sie nicht zu viel Automatisierung oder moderne Benutzerfreundlichkeit in diesem Softwareprodukt erwarten. Sie erhlten es hier: http://getgreenshot.org.
Quelle: getgreenshot.org
10. Windows (Problem) Steps Recorder: Die wenig genutzte kostenlose Dokumentationssoftware
Fast jeder Windows-Benutzer hat ihn auf seinem Computer installiert, aber kaum jemand kennt ihn: Den Steps Recorder, früher „Problem Step Recorder“. Mit diesem Windows-Tool können Anwender Prozesse anhand von Screenshots aufzeichnen, Kommentare hinzufügen und die fertigen Dokumente als Zip-Dateien speichern und weitergeben.
Wie der Name schon sagt, ist der Rekorder dafür gedacht, Probleme aufzuzeichnen – und anschließend an eine Person zu senden, die bei der Fehlersuche hilft.
Als kreative Lösung könnten Sie das Tool auch zur Erstellung eines kurzen Tutorials und einer Software-Dokumentation nutzen. Allerdings ist das Layout des fertigen Handbuchs nicht besonders benutzerfreundlich. Es wurde nie dafür konzipiert oder vorgesehen, ansprechende Software-Dokumentationen zu erstellen, sondern vielmehr als Werkzeug für Entwickler und technische Handbücher gedacht. Die Anleitungen zeigen nicht die genauen Klickpositionen an, und die schriftlichen Beschreibungen der einzelnen Schritte finden sich ganz am Ende des Dokuments, anstatt unter den entsprechenden Screenshots platziert zu sein. Daher ist der „Steps Recorder“ eher eine Notlösung für Anleitungen als ein umfassendes Tool zur Erstellung von Software-Dokumentationen. Es ist auf den meisten Windows-Computern vorinstalliert. Wo Sie den Rekorder finden und weitere Informationen erhalten Sie auf der Windows-Website.
Quelle: support.microsoft.com
Überblick: Die 10 besten Software-Dokumentationstools
| Tool | Desktop oder Browser-basiert | Unterstützte Sprachen | Exportformate | Integrationen | Eigene Export Templates möglich? | Preis |
| FlowShare | Desktop | Englisch, Deutsch, Französisch (automatische Übersetzung in über 30 Sprachen in Kürze verfügbar) | PDF, Word, PowerPoint, HTML, PNG, SCORM, xAPI, OpenRPA | Avendoo, Confluence, WordPress, Synthesia, Nugget Creator | Ja | 40 $ pro Nutzer und Monat |
| iorad | Browser | Englisch und über 20 Sprachen | PDF, Word, HTML, GIF, GDOC, Video, SCORM | Canva, Confluence, Notion unter anderem | Nein | 200 $ pro Benutzer pro Monat |
| Tango | Browser | Englisch | PDF, HTML | Notion, SharePoint, Zendesk unter anderem | Nein | 16 $ pro Benutzer pro Monat |
| Scribe | Browser | Englisch | PDF, HTML, Markdown | Confluence, Notion, SharePoint, Embed | Nein | 23 $ pro Nutzer pro Monat |
| Snagit | Desktop | Englisch | PDF, PNG, JPEG, MP4, GIF, Powerpoint, SNAG unter anderem | Teilbarer Link | Nein | 68.21 € (unbefristete Lizenz, ein Jahr Maintenance) |
| Folge | Desktop | Englisch, Französisch, Deutsch, Spanisch, Portugiesisch | PDF, HTML, Powerpoint, Word, JSON und Markdown | Ja | 69 € (persönliche Nutzung), 130 € (kommerzielle Nutzung) | |
| Screensteps | Desktop | Englisch | PDF, HTML | Screensteps knowledge base, Slack, Teams, Salesforce, unter anderem | Nein | 239 € pro Monat für 25 Nutzer |
| Stepsy | Browser | Englisch | PDF, Word, zip file (Bilder), HTML | Integrationen geplant, aber noch nicht umgesetzt | Nein | 9 $ pro Nutzer pro Monat |
| Greenshot | Desktop | Englisch | JPEG | – | Nein | kostenlos für Windows/1.99 $ Mac |
| Windows Steps Recorder | Desktop | Englisch | Zip-file | – | Nein | kostenlos |
Dies sind nur einige der auf dem Markt befindlichen Dokumentationstools. Weitere Anbieter finden Sie auch in aktuellen Softwaretests.
Und jetzt? Das beste Software-Dokumentationstool für Ihre Bedürfnisse finden
In diesem umfassenden Leitfaden stellen wir einige der besten Software-Dokumentationstools vor und gehen auf ihre Funktionen und einzigartigen Merkmale ein. Die Qualität und die Klarheit der Inhalte sind das Entscheidende bei einer effektiven Wissensvermittlung. Bei der Auswahl der passenden Dokumentationssoftware für Sie sollten Sie daher die folgenden Fragen berücksichtigen:
- Welche Software benötigen Sie für die Dokumentation: Desktop- oder browserbasiert?
- Wie häufig werden Sie dokumentieren?
- Was ist wichtiger für Sie: Automatisierungsgrad, Flexibilität oder beides?
Sobald Sie Ihre Auswahl eingegrenzt haben, testen Sie die Tools. Die meisten bieten die Möglichkeit, sie zu testen, bevor Sie sich zu einem Kauf verpflichten.
Beginnen Sie Ihre reibungslose Reise in die Software-Dokumentation
Wir haben zwar Tools vorgestellt, die auf die Erstellung von Dokumentationen spezialisiert sind, aber es gibt noch eine große Vielfalt an Lösungen für Wissensdatenbanken zu entdecken. Wenn Sie mehr zu diesen Lösungen erfahren wollen, lesen Sie unseren ausführlichen Artikel über die besten Wissensdatenbank-Tools.
Nun sind wir gespannt auf Ihre Meinung:
- Wie haben Sie Ihren Bildschirm aufgezeichnet und Anleitungen verfasst?
- Haben Sie besondere Methoden oder Werkzeuge für eine erfolgreiche Software-Dokumentation?
- Gibt es im Bereich der Software-Dokumentation vielleicht Tools, die wir noch nicht erwähnt haben?
Ihre Einblicke und Erfahrungen sind von unschätzbarem Wert für uns. Senden Sie sie gerne an info@getflowshare.com.
Sind Sie an einem reibungslosen, automatisierten Dokumentationsprozess interessiert? Entdecken Sie FlowShare. Wir bieten eine kostenlose 7-Tage-Testversion an, mit der Sie so viele Anleitungen erstellen können, wie Sie möchten. Tauchen Sie ein in die Welt der automatisierten Software-Dokumentation von FlowShare und lassen Sie Screenshot-Tools und Word hinter sich.
FAQs
Was sind Software-Dokumentationstools?
Werkzeuge, die Anleitungen und Handbücher für Anwender erzeugen: Erfassung, Screenshots, Struktur, Branding und Export. Sie unterscheiden sich weniger im Funktionsumfang als darin, wer damit arbeiten kann und wo die Daten liegen.
Welche Dokumentationssoftware passt zu unserem Anwendungsfall?
Klären Sie zuerst, ob Sie für Anwender oder für Entwickler dokumentieren. Danach entscheiden Betriebsmodell, Exportformate und Pflegeaufwand. Ein Tool für Entwicklerdokumentation löst die Probleme im Fachbereich nicht.
Gibt es Dokumentationstools ohne Cloud?
Ja. On-Premise-Werkzeuge arbeiten lokal und belassen Screenshots auf dem erfassenden Rechner. FlowShare erfasst auf dem Windows-Desktop und funktioniert in abgeschotteten Netzen, weshalb es in regulierten Branchen auf den Auswahllisten steht.
Einzeltool kaufen oder ein Dokumentationssystem aufbauen?
Ein Tool ohne Ablageort, Namenskonvention und Verantwortliche erzeugt nur einen weiteren Datenfriedhof. Sinnvoll ist es, Erfassung, Ablage und Pflege zusammen zu planen, auch wenn Sie klein anfangen.
