CData Software Blog

クラウド連携のCData Software の技術ブログです。

CData のヘルプが、よりシンプルに参照しやすく生まれ変わります!

f:id:TKato:20210426094955p:plain

こんにちは、CData Software でローカライザーをしている加藤です。

CData では毎年の製品アップデートの時期を迎え、ユーザーの皆様に新製品をお届けするため日夜製品の改修・テストに邁進しています。ローカライズの重要な仕事の1つは、ヘルプドキュメントの翻訳です。今回のアップデートでは、CData ドライバーのヘルプドキュメントがナビゲートしやすく大きく刷新されるので、この記事では次の2点をご説明します。

  • どうしてヘルプを刷新するのか?
  • どのようにヘルプは刷新されるのか?

この記事でご紹介する新しいヘルプは、以下のページや製品に同梱される形で、新製品のリリースに合わせてアクセス可能になる予定です。 www.cdata.com

どうしてヘルプを刷新するの?

CData ではこれまで、200を超えるドライバーを提供してきました。CData ドライバーは、ユーザーの皆様のさまざまなデータ連携ニーズを想定して、認証、ログの取得、セキュリティなど、ユーザーの皆様のニーズにあらゆる角度からお応えできるよう、製品機能とそのドキュメンテーションを充実させてきました。とはいえもので溢れた部屋と同じで、情報が増えればそれだけ必要な情報にたどり着くのが難しくなり、整理が必要になります。今回のアップデートでは、ヘルプドキュメント内の必要な情報によりすばやく、簡単にたどりつけるようになりました。さらに更新履歴が追加され、重要な変更・追加点がまとめられたことで、製品アップデートの際などに参考にして頂けます。

ヘルプはどんな風に変わるの?

再構成されて必要な情報にアクセスしやすくなった章立て

f:id:TKato:20210426052442p:plain

章として[高度な機能]が追加され、セキュリティやログの取得など、製品の挙動をより細かく設定したい方向けの情報がまとめられました。[JDBC リモーティング]や[ユーザー定義ビュー]といった一部のユーザーが必要とする機能は、こちらに移動しました。トップの章立てがコンパクトになりましたね!

ログ関連の情報は、[ログ]セクションにまとめられました。これまで関連した情報がいろいろな箇所にあったログの情報ですが、今回1つのセクションにまとめられ、ぐっと参照しやすくなりました。Verbosity に関しては以前のバージョンから記載がありましたが、[基本的なログの記録]などの項目とはわけられて、該当する接続文字列の中でだけ紹介されていました。

f:id:TKato:20210426052933p:plain

整理されて格段に探しやすくなった接続文字列

f:id:TKato:20210426052503p:plain

例えばSalesforce ドライバーの場合、接続文字列は80近くまで増加しています。これまではアルファベット順での配置でしたが、オプションの数が増えるにつれ、必要な項目をより簡単に見つけることができる方法が必要になってきました。今回のアップデートでは、カテゴリ毎に文字列をまとめることで目的に沿った利用が圧倒的にしやすくなりました!変更前はアルファベット順の配置だったものが、[Authentication](認証)、[Connection](接続)といったカテゴリに分類されて、さらにユーザーの使用頻度を考慮して並び替えられています。

更新履歴が追加され、バージョンアップがより手軽に

既存ヘルプドキュメントの整理・再構成だけではなく、新しく[更新履歴]セクションが追加されました。これまでの変更点が一目でわかるようになり、過去のバージョンからご利用頂いているお客様のバージョンアップの際に役立ちます![変更履歴]では、製品に追加された機能、非推奨になった機能などが一覧され*1、バージョンアップの際「よく使っていたあの機能はどうなったの?」、「どんな機能が追加されたの?」といったユーザーの皆様の疑問にお答えします。

f:id:TKato:20210426052948p:plain

その他の変更点

  • 接続・認証関連の説明の追加 OAuth やOkta、ADFS、SSO など、ユーザーの皆様の多様な認証にニーズにお応えするため、認証に関する説明をさらに充実させました。

  • copyright が追加 MIT ライセンスやBSD ライセンスなど、CData 製品で利用しているフリーソフトウェア関連のライセンスが追加されました。

おわりに

CData では、皆様のデータ連携ニーズをスムーズに実現できるよう、使いやすい製品を目指して日々製品の改善を行っています。今回のヘルプの刷新では、章・セクションや接続文字列の配置を整理して、皆様が一層必要な情報にアクセスしやすいヘルプを目指しています。今後もCData では、皆様が使いやすい製品を目指して日々製品・ヘルプの改善を行って参ります。

*1:2021年4月時点では、2020年の終わり頃からの変更点を記載しています