Die leistungsfähigste Entwicklungsumgebung – jetzt für das Schreiben von Dokumentationen optimiert
Verwenden Sie eine Authoring-Komplettumgebung – sparen Sie sich den Einsatz zahlreicher unterschiedlicher Tools. Mit einer integrierten Git-UI, einem eingebauten Build-Tool, automatisierten Tests und einem einsatzfertigen und individuell anpassbaren Layout können Sie sich auf das Wichtigste konzentrieren – Ihre Inhalte.
Sie haben jetzt die Möglichkeit, die Vorteile von Markdown mit denen von semantischen Markups zu kombinieren. Sie können bei einem Format bleiben oder Markdown um semantische Attribute und Elemente, Mermaid-Diagramme und LaTeX-Mathematikformeln erweitern.
Gewährleisten Sie die Qualität und Integrität Ihrer Dokumentation mit mehr als 100 Hintergrundinspektionen im Editor sowie Tests in der Live-Vorschau und während des Buildvorgangs.
Die Vorschau zeigt die Dokumente exakt so an, wie Ihre Leser*innen sie sehen werden. Lassen Sie sich Vorschauen einzelner Seiten direkt in der IDE anzeigen oder öffnen Sie die gesamte Hilfe-Website in Ihrem Browser, ohne den Build auszuführen.
Verwenden Sie beliebige Inhalte wieder, von kleineren Inhaltsblöcken über Inhaltsverzeichnisse bis hin zu ganzen Themenbereichen. Filter und Variablen sorgen für eine hohe Flexibilität. Für komplexe Markup-Elemente können Sie vordefinierte Vorlagen verwenden oder Ihre eigenen Vorlagen konfigurieren.
Sparen Sie sich das Hin und Her zwischen unterschiedlichen Tools bei der Erstellung von Benutzerdokumentationen und API-Referenzen. Integrieren Sie API-Dokumentationen in Ihre Hilfe-Website, veröffentlichen Sie sie im gleichen Layout und ergänzen Sie automatisch generierte Referenzen durch manuell geschriebene Inhalte.
Dieses Projekt ist das Ergebnis von Hunderten Kundeninterviews und über 10 Jahren Arbeit an den Dokumentationen für die IntelliJ-Plattform. Aus diesen Erfahrungen entstand eine lange Liste von Funktionswünschen und zu lösenden Problemen. Wir sind entschlossen, diese Punkt für Punkt abzuarbeiten.
Sie möchten helfen? Probieren Sie Writerside aus und sagen Sie uns Ihre Meinung dazu!
Viele JetBrains-Produkte nutzen bereits unsere Dokumentationsplattform. Und jetzt haben Sie die Möglichkeit, unser gesamtes Wissen, unsere Erfahrung und unsere Vorlagen zu nutzen, um Dokumentationen für Ihre eigenen Produkte zu erstellen.
Writerside befindet sich jetzt in der Early-Access-Phase und wird völlig kostenlos bereitgestellt.
Auch nach der Veröffentlichung von Writerside wird es eine kostenlose Version oder ein fortlaufendes EAP-Programm geben, sodass Sie das Tool weiterhin kostenlos nutzen können.
Writerside nutzt zwei Arten von Quellcode-Dateien: Markdown und XML. Dies heißt jedoch nicht, dass Sie sich auf ein einziges Format festlegen müssen. Sie können in Markdown schreiben und komplexere Elemente – etwa semantische Attribute und XML-Elemente – einbinden. Für beide Markups wird eine vollständige Editorunterstützung inkl. Completion und Validierung bereitgestellt.
Wenn Ihre Quelldaten hauptsächlich in XML vorliegen, werden Sie Änderungsanfragen von externen Autoren in Markdown entgegennehmen und das Markdown-Format in XML konvertieren können. Ebenso können Sie Markdown-Fragmente in XML umwandeln, zum Beispiel wenn Sie Zellen in einer Tabelle verbinden wollen.
Wir sind zuversichtlich, dass die Kombination von Markdown und semantischem XML-Markup die meisten Anwendungsfälle abdeckt. Wir sind jedoch offen für Rückmeldungen – lassen Sie es uns also bitte wissen, wenn Ihnen Funktionen fehlen, die von anderen Markup-Technologien unterstützt werden.
Sie können Dateien lokal speichern, aber die Verwendung eines Git-Repository wird empfohlen. Wir stellen eine komfortable Bedienoberfläche für alle Git-Operationen zur Verfügung, inklusive der Verwaltung von Branches und dem Lösen von Konflikten. Sie können auch ein anderes unterstütztes Versionsverwaltungssystem verwenden, z. B. Subversion oder Perforce.
Wir sind zwar von webbasierten Dokumentationen überzeugt, aber manchmal kann es Situationen geben, in denen gedruckte Formate benötigt werden. Ab Januar 2024 unterstützen wir daher die PDF-Ausgabe.
Mit Writerside können Sie Ihr Dokumentationsprojekt lokal erstellen und in eine .zip-Datei verpacken. Dann laden Sie es auf Ihre Website hoch oder hosten es auf GitHub Pages, Amazon AWS, Netlify oder einem anderen Hosting-Dienst. Wir erwägen, in Zukunft einen eigenen Hosting-Service für Dokumentationen anzubieten.
Wenn Sie einen CI/CD-Server verwenden, können wir Ihnen Builder-Skripte als Docker-Container bereitstellen, die Sie zur Konfiguration von Dokumentations-Builds verwenden können.
Sie können Writerside so konfigurieren, dass es Algolia-Suchindizes erstellt, und Sie können sich für einen kostenlosen Algolia-Tarif anmelden.
Wir arbeiten auch an einer eigenen Suchlösung.
Die Early-Access-Version von Writerside bietet einige Anpassungsoptionen. Unter anderem stehen Ihnen folgende Möglichkeiten zur Verfügung:
Wir wollen weitere Optionen hinzufügen und eine noch flexiblere Anpassung von Dokumentationen ermöglichen.
Wenn Sie über Markdown-Quelltexte verfügen, können Sie diese in ein Writerside-Projekt importieren. Wir arbeiten auch an der Migration von XML-basierten Formaten wie DITA.
Wir veröffentlichen regelmäßig Informationen in unserem Slack-Workspace (bitte lesen Sie unseren Verhaltenskodex vor dem Beitritt). Sie können außerdem unser Projekt in YouTrack verfolgen und alle aufkommenden Probleme oder Funktionswünsche melden.
Sie können auch unseren Newsletter abonnieren, um über wichtige Produktneuigkeiten informiert zu werden.
Sind Sie dabei?
Wir haben eine Leidenschaft für gute Dokumentation und wollen allen, die in diesem Bereich arbeiten, die bestmöglichen Werkzeuge bieten – idealerweise mit Ihrer Hilfe. Nehmen Sie also Kontakt mit uns auf!
Abonnieren Sie unseren Newsletter
Geben Sie Ihre E-Mail-Adresse ein, um Produktinformationen zu Writerside und praktische Tipps zum Erstellen von Dokumentationen zu erhalten: