このブログ記事では、Qt 6.9 リリースにおけるQt フレームワークのドキュメントで確認できるドキュメントナビゲーションの改善についてお話ししたいと思います。
以前は、ドキュメントポータルは主に検索に頼っていました。つまり、リクエストを入力して結果を得るという方法です。これは、Qtの世界でどのように名前が付けられているかを知っている場合にはうまく機能します。しかし、別のプラットフォームからQtに切り替えた場合、検索ボックスに何を入力すればよいのかが分かりますか？特定のモジュールの機能を探りたい場合はどうでしょうか？この場合、Qtのドキュメントにはより優れたナビゲーションが必要です。
Qt 6.9 では、Qt Creator のヘルプビューアにおける各モジュールのドキュメント構造を再編成しました。
Qt Creatorのヘルプビューアでは、各モジュールごとに用意されているすべてのトピックがツリー構造で整理されています。
Qtフレームワーク全体に共通するナビゲーションツリーをオンラインドキュメントに追加しました。
このツリーには、モジュールドキュメントがサブツリーとして含まれています。Qt Core、Qt GUI、Qt Quick などの主要なモジュールはツリーの最上位に配置されています。モジュールサブツリーには、他の関連モジュールに関するドキュメントが含まれている場合があります。例えば、Qt Quick サブツリーには、他の Qt Quick 関連モジュールが含まれています。
モジュールサブツリーには、Qt Installer に同梱されているすべてのアドオンが含まれています。
正直に申し上げて、まだ作業は完了していません。現在、このようなナビゲーションが存在しなかった膨大なドキュメントセットにツリーを追加した状況にあります。新しいナビゲーションツリーは、新しい機能に加えて、新たな課題をもたらしました。新しいナビゲーションを念頭に置いてドキュメントを記述する必要があります。
トピックツリーを改善できる、またはツリーに関連するコンテンツを最適化できると思われる場合は、Documentationコンポーネントのチケットをbugreports.qt.ioで作成し、ナビゲーションやコンテンツをどのように改善できるかについて詳しく説明してください。