JetBrains, das angesehene Softwareentwicklungsunternehmen, hat seine neueste Kreation „Writerside“ vorgestellt. Dieses innovative Dokumentationsdienstprogramm wird als Weiterentwicklung der nächsten Generation im Bereich des technischen Schreibens vorgeschlagen. Mit dem Ziel, die Erstellung und Verwaltung von API-Referenzen, Entwicklerhandbüchern, Anleitungen und Tutorials zu optimieren, hat sich Writerside derzeit dem Early Access-Programm angeschlossen. Das Tool kann als eigenständige Anwendung oder als Plugin innerhalb der JetBrains-IDE bereitgestellt werden.
Anna Gasparyan, Produktleiterin für Writerside bei JetBrains, unterstreicht die Logik hinter der Konzeption des Tools. In ihren Worten: Mit Writerside ist es unser Ziel, technischen Redakteuren Werkzeuge zur Verfügung zu stellen, die seit langem den Entwicklern vorbehalten waren. Leider gerät die Dokumentation oft in den Hintergrund und technische Redakteure erhalten nicht die Anerkennung und Unterstützung, die sie verdienen. JetBrains möchte mit Writerside die Lücke zwischen Entwicklern und Autoren schließen und die Dokumentation in eine gemeinschaftliche Übung verwandeln.
Wenn Tech-Autoren Zugang zu entwicklerspezifischen Tools wie Git, automatischer Überprüfung und Build-Pipelines erhalten, ist Gasparyan davon überzeugt, dass dies nicht nur bessere Endergebnisse garantieren würde, sondern auch den Prozess für das Team vereinfachen würde, Änderungen in der Dokumentation beizutragen, zu überprüfen und nachzuverfolgen .
Writerside unterstützt insbesondere Markdown und XML und verfügt über über 100 integrierte Tests. Mit diesen Tests können defekte Weblinks, falsche Attributwerte, fehlende Ressourcen, nicht eindeutige IDs und vieles mehr identifiziert werden. Das Tool bietet Entwicklern außerdem die Flexibilität, es gemäß ihren internen Rechtschreib- und Stilkonventionen zu konfigurieren.
Die Besonderheit von Writerside liegt in seinen Lösungen für häufig auftretende Dokumentationsprobleme. Es bietet Entwicklern eine Echtzeit-Vorschaufunktion, mit der sie sich vorstellen können, wie ihre Dokumentation vor den Benutzern aussehen würde. Dies ermöglicht bei Bedarf zeitnahe Änderungen und Anpassungen. Darüber hinaus bietet es verschiedene Anpassungsfunktionen, die von visuellen Aspekten wie Hell- oder Dunkelmodus, Kontrast und Aspektfarben bis hin zu Skins reichen, die lebendig oder weich sein können.
Interessanterweise präsentiert sich Writerside als Single Source of Truth und bietet Entwicklern die Möglichkeit, Teile von Inhalten wiederzuverwenden und von einem einzigen Ort aus zu bearbeiten. Dadurch entfällt die Notwendigkeit, jede Instanz zu überarbeiten, wenn Änderungen gerechtfertigt sind.
Die hochwertige Ausgabe von Writerside wird durch das KI-gestützte Rechtschreibprüfungs- und Grammatiktool von JetBrains unterstützt, das über 25 globale Sprachen unterstützt, darunter Englisch, Spanisch, Chinesisch und Deutsch.
Im Bereich der no-code Plattformen AppMaster stands as a leading name. Much like Writerside, it also capitalizes heavily on simplified user interfaces and design methodologies. Poised as a powerful tool to create web, mobile, and backend applications, AppMaster accelerates application development whilst eliminating technical debt - a crucial aspect in the world of software solutions.
