最高のチュートリアルハウツー API リファレンスユーザーガイド SDK ドキュメントを執筆、テスト、ビルド、公開しましょう

ドキュメントの執筆に適した最強の開発環境

Docs-as-code をすぐに実現

Docs-as code パイプライン

単一のオーサリング環境を使用するため、多様なツールを用意する必要はありません。組み込みの Git UI、統合ビルドツール、自動テスト、既製のカスタマイズ可能なレイアウトを使用することで、最も重視すべきドキュメントの内容に専念できます。

Markdown と XML の組み合わせ

Markdown のメリットをセマンティックマークアップのメリットと同時に享受できるようになりました。1 つの形式を使用することも、セマンティックな属性と要素、Mermaid ダイアグラム、および LaTex 数式を使用して Markdown をリッチにすることもできます。

ドキュメント品質の自動化

エディターに搭載された 100 個以上のオンザフライインスペクション、さらにライブプレビューとビルド中のテストにより、ドキュメントの品質と整合性を保証できます。

ライブプレビュー

プレビューでは閲覧者が実際に見る同じドキュメントが表示されます。ビルドを実行せずに IDE で単一のページをプレビューしたり、ブラウザーでヘルプサイト全体を開いたりできます。

単一ソース

比較的小さな内容の塊からトピック全体、あるいは目次のセクションまで、なんでも再利用できます。フィルターや変数を使って柔軟に対応できます。複雑なマークアップ要素に事前定義済みのテンプレートを使うことも、独自に構成することも可能です。

API と製品ドキュメント、集合!

ユーザードキュメントと API リファレンスを作成する際に、異なるツールを行き来する必要はもうありません。 API ドキュメントをヘルプサイトに統合し、同じレイアウトで公開し、自動生成されたリファレンスを手書きコンテンツで補足しましょう。

仕組みを見る

ドキュメント作成者が
ドキュメント作成者向けに作成

このプロジェクトは数え切れないほど多くの顧客インタビューと IntelliJ プラットフォームのドキュメントに 10 年以上取り組んできた経験から生まれました。この経験により、多くの作成すべき機能と解決すべき問題を洗い出すことができました。私たちはそれらに 1 つずつ対応していくつもりです。

ご協力いただける方は、Writerside をお試しになり、ご意見をお聞かせください!

Writerside を使って作成したドキュメントの例

多くの JetBrains 製品はすでに JetBrains のドキュメントプラットフォームを採用しています。弊社のすべての知識、経験、およびテンプレートを使用して、お客様独自の製品用にドキュメントを作成できるようになりました。

よくあるご質問

現在、Writerside は早期アクセスプログラムとして配布されており、全て無料でご利用いただけます。

Writerside のリリース後も無料バージョンを提供するか EAP プログラムを継続しますので、無料でツールを使用し続けることができます。

Writerside には Markdown と XML の 2 種類のソースファイルがありますが、1 つの形式を使用しなければならないというわけではありません。Markdown で記述し、セマンティックな属性や XML 要素などのより複雑な要素を注入することができます。どちらのマークアップについても、エディターは補完や検証を含む支援機能を完備しています。

主なソースベースが XML である場合、外部貢献者から Markdown で変更リクエストを受け付けてから Markdown を XML に変換することができます。同様に、テーブルのセルを結合する必要がある場合などに Markdown のコードを XML に変換できます。

Markdown とセマンティックな XML ベースのマークアップの組み合わせでほとんどのユースケースに対応できると見込んでいます。ただし、フィードバックは受け付けていますので、他のマークアップが提供する機能が不足している場合はお知らせください。

ファイルはローカルに保管できますが、Git リポジトリを使用することをお勧めします。あらゆる Git 操作、ブランチの管理、および競合の解決を行える便利な UI を提供しています。Subversion や Perforce など、サポートされている他のバージョン管理システムも使用できます。

弊社はウェブベースのドキュメントが最適だと考えていますが、印刷されたドキュメントが必要になる場合もあるかと思います。2024 年 1 月時点では PDF の出力をサポートしています。

Writerside ではドキュメントプロジェクトをローカルで作成して .zip ファイルを生成できます。その後はそのファイルをウェブサイトにアップロードするか、GitHub Pages、Amazon AWS、Netlify、またはその他のホスティングサービスでホストする必要があります。将来的には弊社独自のドキュメントホスティングサービスを提供することを検討中です。

CI/CD サーバーを使用している場合、弊社からビルダースクリプトを Docker コンテナーとして提供できます。これを使用してドキュメントのビルドを構成できます。

Algolia 検索インデックスを生成するように Writerside を構成し、無料の Algolia プランに登録できます。

弊社は独自の検索ソリューションにも取り組んでいます。

Writerside の早期バージョンにはいくつかのカスタマイズオプションがあります。たとえば、以下のような操作が可能です。

  • ヘッダーとフッターの表示を変更する。
  • ロゴとコピーライトを追加する。
  • ライトテーマとダークテーマの両方をサポートする 3 つの色プリセット(ソフト、コントラスト、および鮮明)から選択する。
  • ハイライトされる要素の強調色を選択する。
  • ソーシャルメディアやその他のリソースへリンクを埋め込む。

今後はさらに多くのオプションを追加し、ドキュメントのカスタマイズをさらに柔軟に行えるようにする予定です。

Markdown のソースをお持ちの場合は、Writerside プロジェクトにソースをインポートできます。DITA などの XML ベースの形式からの移行にも取り組み中です。

更新情報は定期的に Slack workspace に投稿されています(参加する前に Code of Conduct(行動規範)をお読みください) 。また、YouTrack で弊社プロジェクトをフォローし、発生した問題や機能リクエストをご報告いただけます。

すべての製品メジャーアップデートの告知を含むニュースレターを購読することもできます。