JetBrainsは、WriterSideにより開発者とライターが、書き込み、テスト、ビルドのワークフローを使用して技術文書を作成できることを目指している。この新しいツールはIntelliJ-platform IDEsをベースにしており、ここ数年JetBrains製品のほとんどのドキュメント作成に使用されている。
このプロジェクトは、何百回もの顧客インタビューと、10年以上にわたるIntelliJ Platformのドキュメント作成の経験から発展しました。これらの経験から、私たちは構築すべき機能と解決すべき数々の問題をリストアップしました。
WriterSideの重要な目標の一つは、開発者とライターの効果的なコラボレーションを可能にし、両者のギャップを埋めることである。WriterSideは、Git、プルレビュー、自動チェックなどの開発ツールに基づく "doc as code "パイプラインを実施することで、チーム全体がコードと同じように貢献、レビュー、変更の追跡を可能にする。JetBrainsによれば、これによりドキュメンテーションパイプラインが簡素化される。
WriterSideはMarkdownとカスタムXMLベースのマークアップの両方をサポートしており、作成者は同じドキュメントで両方のフォーマットを組み合わせることができる。これにより、例えばMarkdownドキュメントにセマンティック属性を差し込み、表現力を高めることが可能になる。逆に、WriterSideはMarkdownフラグメントをその場でXMLに翻訳し、XMLドキュメントへのインポートもサポートしている。
WriterSideは、リンク切れ、リソースの欠落、属性値の誤りなど、100以上の組み込みテストを実行できる。テストは社内のスペルやスタイル規則に合わせてカスタマイズできる。このツールは、簡単にカスタマイズできる定義済みのデザインも用意されているので、作者はレイアウトやCSSを扱う必要がない。
製作者はXMLまたはMarkdownを記述する必要があるため、WriterSideにはすべての変更を即座に反映し、エラーをハイライトするライブプレビュー機能が含まれている。これはCI/CDパイプラインにアクセスできない場合や、ビルドが長引く場合に特に有用で、ビルドが終了するのを待たずに出力を確認できる。
WriterSideの機能についての最後に補足しておくと、AIベースのスペルチェッカーと25以上の言語をサポートするJetBrainsによって構築された文法修正を提供している。
WriterSideはJetBrains IDEのプラグインとして、また早期アクセスプログラム（EAP）の下でスタンドアロンアプリケーションとして利用できる。EAP期間中は完全無料だが、JetBrainsは無料版または継続的なEAPを用意し、無料でツールを使用できるようにすると約束した。