Das Schreiben von Softwaredokumentationen spielt eine wesentliche Rolle in der Arbeit eines Programmierers. Wie sie sagen: Wenn es nicht dokumentiert ist, dann existiert es nicht, und in den meisten Fällen ist die ordnungsgemäße Dokumentation Ihres Codes genauso wichtig wie das tatsächliche Schreiben. „Egal wie wunderbar Ihre Bibliothek ist und wie intelligent ihr Design ist, wenn Sie der Einzige sind, der sie versteht, nützt sie nichts. Unter Dokumentation versteht man nicht nur automatisch generierte API-Referenzen, sondern auch kommentierte Beispiele und ausführliche Tutorials. Sie benötigen alle drei, um sicherzustellen, dass Ihre Bibliothek problemlos übernommen werden kann“, sagte Nicholas Zakas, ein bekannter Front-End-Ingenieur und Buchautor. Aus diesem Grund haben wir uns heute entschlossen, einen Blick auf einige der besten und am häufigsten verwendeten Tools für Softwaredokumentation und technisches Schreiben zu werfen.
Hilfe-Authoring-Tools
Hilfe-Authoring-Tools spielen eine wichtige Rolle in der Softwaredokumentation und im technischen Schreiben, da sie das Entwerfen, Schreiben, Veröffentlichen und Verwalten von Softwaredokumentation erheblich erleichtern. Sie ermöglichen es Ihnen, den Zeit- und Arbeitsaufwand bei der Erstellung aller Arten von Hilfsmaterialien sowohl für Endbenutzer als auch für andere Programmierer/Mitarbeiter zu reduzieren.
MadCap Flare ist eines der beliebtesten Hilfe-Authoring-Tools, da es eine große Auswahl an Funktionen bietet, mit denen Sie viel mehr tun können, als nur Hilfedokumentation zu schreiben. MadCap Flare wurde für erweitertes themenbasiertes Authoring, Single-Source-Publishing und Content-Management entwickelt. Sie können damit Hilfe- und Kundensupport-Websites, FAQs, Wissensdatenbanken, Online-Lernzentren, Leitfäden, Richtlinien- und Verfahrenshandbücher und mehr erstellen. Die Funktionen von MadCap Flare machen es einfacher, denselben Inhalt in mehreren Kanälen wiederzuverwenden und ihn schnell auf verschiedenen Plattformen zu veröffentlichen.
Document360 ist eine weitere weit verbreitete Webplattform, mit der Sie alle Arten von Wissensdatenbanken und Hilfematerialien erstellen, veröffentlichen und aktualisieren können. Es verfügt außerdem über Funktionen für mehrere Profile, darunter einen einfachen Markdown-Texteditor, einen Category Manager zum Aufbau der Wissensdatenbankstruktur, Funktionen zur Anpassung der Zielseite, Rollback der Versionierung, Sicherung und Wiederherstellung, flexible Rollen- und Berechtigungsanpassung usw.
Adobe RoboHelp ist ein weiteres leistungsstarkes alternatives Hilfe-Authoring-Tool, das im Vergleich zu MadCap Flare und Document360 eine etwas andere Auswahl an Funktionen bietet. Insbesondere bietet Adobe RoboHelp eine einfache Multiformat-Veröffentlichung, mit der Sie Inhalte in einer Vielzahl gängiger Ausgabeformate veröffentlichen können, darunter Frameless Responsive HTML5, PDF, Microsoft Help (CHM) und sogar weniger verbreitete Formate wie EPUB 3, KF8 und MOBI.
Der Hauptvorteil von Help+Manual ist seine einfache Benutzeroberfläche, die es sehr zugänglich und benutzerfreundlich macht, zusammen mit der vollen Funktionalität eines WYSIWYG-XML-Editors, Multi-Channel-Publishing, voller Unterstützung für Multimedia und komplexe modulare Projekte, Webhelp-Tool für die nahtlose Integration von Dokumentation in aktive Websites usw.
ClickHelp bietet außerdem eine recht leistungsstarke Webplattform für Softwaredokumentation in Form von Wissensdatenbanken, FAQs, Tutorials und anderen Hilfeformaten. Unterstützt mehrere Formate wie Word, HTML, RTF, CHM, ODT, CHM, HTML5-Webhilfe, PDF, DOCX usw. Einige der charakteristischen Funktionen von ClickHelp sind die patentierte Volltextsuche, die das Auffinden bestimmter Themen oder Artikel erleichtert Autoren und Benutzer sowie eine Auswahl aus mehreren vorgefertigten Vorlagen für das Dokumentationsdesign.
Tools zur Bildschirmaufnahme
Die meisten Softwaredokumentationen und Hilfematerialien müssen Screenshots enthalten. Daher wäre es sinnvoll, einen kurzen Überblick über die besten verfügbaren Tools zur Bildschirmaufnahme zu geben.
Wenn Sie Windows als Betriebssystem verwenden, wird ein Snipping-Tool mitgeliefert, mit dem Sie Screenshots des gesamten Bildschirms, einzelner Fenster oder eines Teils des Bildschirms erstellen und mit dem Stiftwerkzeug bestimmte Teile des Screenshots hervorheben können.
FireShot ist ein beliebtes Browser-Plugin, das nahezu alle modernen Browser wie Chrome, Firefox, Internet Explorer und Opera unterstützt. Ermöglicht die Erfassung der gesamten Webseite oder eines bestimmten Teils davon.
SnagIt ist ein komplexeres Tool zur Bildschirmaufnahme. Es ermöglicht Ihnen, Bildlaufbereiche jeder Seite zu erfassen und unterstützt die Videoaufzeichnung. Sie können dieses Bild auch verwenden, um GIFs zu erstellen und bestimmte Aktionen auf dem Bildschirm aufzuzeichnen.
Rechtschreib- und Grammatikprüfung
Es ist auch wichtig, dass Ihre Dokumentation korrekt verfasst ist und keine Grammatik- und Zeichensetzungsfehler enthält. Hier sind einige Tools, die Ihnen helfen, Fehler in Ihren Texten zu finden und zu beheben.
Eines der beliebtesten kostenlosen Online-Rechtschreib- und Grammatikprüfprogramme. Schreiber können über 250 verschiedene Arten von Fehlern identifizieren und korrigieren, darunter Substantive, Pronomen, Präpositionen, Verben, Homonyme, Zeichensetzung, Typografie und so weiter.
Ein weiteres tolles kostenloses Tool, das verschiedene Fehler in Ihren Texten lokalisiert und zahlreiche Optionen zur Verbesserung Ihrer Formulierung bietet.
Zusätzlich zur Anzeige von Tippfehlern und Fehlern in Ihren Texten stellt Ihnen Grammar.com relevante Vorschläge sowie Grammatikregeln und E-Books zur Verbesserung Ihres Schreibens zur Verfügung (alles kostenlos).
„Egal wie wunderbar Ihre Bibliothek ist und wie intelligent ihr Design ist, wenn Sie der Einzige sind, der sie versteht, nützt sie nichts. Unter Dokumentation versteht man nicht nur automatisch generierte API-Referenzen, sondern auch kommentierte Beispiele und ausführliche Tutorials. Sie benötigen alle drei, um sicherzustellen, dass Ihre Bibliothek problemlos übernommen werden kann“, sagte Nicholas Zakas, ein bekannter Front-End-Ingenieur und Buchautor. Aus diesem Grund haben wir uns heute entschlossen, einen Blick auf einige der besten und am häufigsten verwendeten Tools für Softwaredokumentation und technisches Schreiben zu werfen.
GO TO FULL VERSION