Nuxeoの「ドキュメンテーション」サイトがスクリーンショット管理の向上を証明

インタフェースを伴うアプリケーションのマニュアルを制作する際、常に考えるべき重要な点は、明確かつ簡潔に書くことです。が、スクリーンショットや図解、ビデオ、GIFなどのビジュアル素材を追加することも重要です。文脈をもたらして、説明していることを上手に伝えられるようになるためです。

とはいえ、これらのビジュアル素材は、マニュアルを更新する際に一緒に更新する必要があり、マニュアル制作の作業工程でも時間のかかる負担のひとつであり続けてきました。マニュアルに含めるビジュアル素材が多ければ多いほど、このプロセスにかかる時間は増大します。

それに、多数のマニュアルを読んだ経験があればお分かりかもしれませんが、アイコンやスクリーンショットなどを示した説明に従って何らかの手順を踏もうとする際に、自分が使っている最新バージョンで違う画面が表示されることほど不満の溜まる体験はありません。

Nuxeoの「ドキュメンテーション」ページには、コンテンツサービスプラットフォームのコンセプトやユースケースを分かりやすく解説するため、全部で9,000枚ほどのスクリーンショットが使われています。ですから、製品のUIを更新するたびに、これらのスクリーンショットも最新バージョンに更新するための膨大な作業が必要になります。ユーザの皆様を混乱させないようにするためです。実際、NuxeoのUIとUXは過去数年間で大幅に向上したと自負しています！

##スクリーンショットの管理：改良前
わずか数か月前まで、Nuxeoは自社のスクリーンショットをGitHub Documentationリポジトリに保管し、この大量のファイルを管理するのにGit LFSを使用していました。このため、（基本的に四半期ごとの製品リリースに伴って）UIやUXが変更になるたびに、すべてのスクリーンショットを更新する必要がありました。すべての関連バージョンとすべてのドキュメンテーションタイプ（テクニカル、ファンクショナル、チュートリアルなど）です。スクリーンショットの名前が変更されていれば、ドキュメンテーション全体にわたって、その名前を更新しなければなりませんでした。

多数の製品をリリースし、多数の時間をスクリーンショットの更新に費やした挙げ句、Nuxeoでは、いい加減、この管理プロセスを改善しようではないかと考えました。ならば、市場で最もモダンで革新的なコンテンツサービスプラットフォームを使う以上に優れた選択はありません。それはもちろん、Nuxeoの製品です！

##スクリーンショットの管理：改良後
ドキュメンテーションの制作過程は、Nuxeoの社員ほぼ全員がコラボレーションするプロセスであるため、使い勝手が良く、メンテナンスも簡単なものにしたいと思いました。そこで、まずはNuxeo Studioでカスタムドキュメントタイプを作成し、具体的なメタデータ属性を定義しました。アセットの取得元となった製品とバージョン、アセットの性質（スクリーンショット、スキーマ、GIFなど）、説明といった属性です。さらに、これらのドキュメントタイプのための検索も作成して、スクリーンショットを更新する必要があるかどうかをユーザが一目で見て判断できるようにしました。

また、このドキュメントタイプには固有のIDを生成するスクリプトを追加して、関連するドキュメンテーションのページにIDを使えるようにしました。次のようなスクリプトです。

{{!--     ### nx_assets ###
    path: /default-domain/workspaces/Product Management/Documentation/Documentation Screenshots/Studio/NOS/Connect Application Edited
    name: CONNECT-application-edited.png
    studio_modeler#screenshot#up_to_date
--}}
![CONNECT Application Edited](nx_asset://640a8741-e75e-46b3-b0ce-68cfe11702f5)

最後のステップは、このプラットフォームをドキュメンテーションのウェブサイトに接続することでした。これにより、ドキュメンテーションのビルドが再起動するたびに（1日1回、自動的に行われます）、前回からスクリーンショットの更新があったかどうかを確認して、更新されたスクリーンショットを表示するようになります。

具体的には、ドキュメンテーションの参照しているすべてのスクリーンショットのメタデータをコードがフェッチして、次に関連するBLOBをフェッチします。

##今後の計画は？
次のステップは、既存のスクリーンショットをNuxeoのプラットフォームに移行して、カスタムドキュメントタイプに変換することです。そして、これらのアセットの取得方法を今後も改善し続けることで、ビルド時間を短縮していきます。これについては、すべてのアセットのマニフェストを一度にフェッチして、それらのアセットのS3での保管場所に単純にリンクさせる計画です。

その後は、使用範囲を拡大して、NuxeoのDAMがもたらすスクリーンショット管理のメリットである自動リサイズ、ウォーターマーク、自動品質管理、アラートなどの機能を、フルに活用していきます。

Nuxeoの「ドキュメンテーション」ウェブサイトには今後も新機能を多数導入していく予定ですので、ぜひご注目ください。そして、いつものことながら、フィードバックは大歓迎です！

ManonはNuxeoのリードテクニカルライターです。略歴はこちらをご覧ください。