はじめに
ローコードテスト自動化ツールとして優れた機能を持つ Tricentis Testim ですが、トライアルや導入検討、活用していく中で感じた課題を解決するために、非公式の 「Tricentis Testim Docs 日本語翻訳サイト」を制作・公開しました。
本記事では、この日本語翻訳サイトを立ち上げたきっかけや、感じていた課題、解決したかったことについて書いていきます。
制作したWebサイト
今回制作したサイトはこちらです。
重要事項
本サイトは個人の活動による非公式日本語翻訳サイトです。本サイトに関して Tricentis Japan 様への直接のお問い合わせはご遠慮ください。
-
許諾について:
- 日本語翻訳サイトの制作・公開は、事前に Tricentis Japan 様から許諾 をいただいた上で公開しております。決して無断で制作・公開しているものではありません。
-
翻訳精度:
- 原文の英語ドキュメントは AI を利用して翻訳しています。作成・更新時に確認は行っていますが、気になる点があればご指摘いただけますと幸いです。
-
更新頻度:
- ドキュメントは可能な限り最新の状態を保つよう努めますが、常に最新であることをお約束するものではありませんので、あらかじめご了承ください。
日本語翻訳サイト立ち上げの背景
E2Eテスト自動化の取り組みにおいて Tricentis Testim を導入し、日々活用しています。導入当初はコアメンバーによる特定のプロダクトでのみ活用していたため、公式の英語ドキュメント参照でも大きな不便は感じていませんでした。
しかし、活用が進み導入効果や成果を共有していく中で、他部署や他事業部からも「利用してみたい」という声が上がるようになりました。そこで、 Testim の紹介や使い方について MTG で説明していたのですが、その際にローカライズに関する課題が多く挙がったため、これをどうにかできないかと考えたことが、立ち上げのきっかけです。
ローカライズの壁
Tricentis Testim は残念ながら日本語にローカライズされておらず、UI やドキュメントはすべて英語です。
そのため、社内の MTG では次のような声が多く上がっていました。
- 色々なことができそうなのは分かったけど、全部英語なのは辛い
- 英語ドキュメントだと、どんなことができるのか理解するまでに時間がかかる
- 設定を変更したい時に、英語ドキュメントだとこの手順で本当に合っているのか? と不安になる
こうした声を聞くと、ブラウザの翻訳機能や AI があるのだから、英語ドキュメントでも問題ないのでは? と思われる方も多いと思います。筆者も当初はそのように考えていました。
しかし、すべての人が英語ドキュメントに慣れているわけではありません。特に企業で利用するツールにおいては、どんなに便利であっても、安心して使ってもらえなければ活用が進みません。
興味を持ってもらえているにも関わらず、ちょっとした不安が原因で使ってもらえない、活用や導入の検討から外れてしまうのは、非常にもったいないと感じ、行動を起こしました。
立ち上げまでにやったこと
行動を起こすことを決めたものの、Testim は公式の商用サービスです。無断でサイトを立ち上げて公開し、問題になる事態は避けたかったため、以下のステップで進めました。
1. Tricentis Japan 様から非公式の日本語翻訳サイト立ち上げについて許諾を得る
まず最初にやったこととして、Tricentis Japan 様に課題を共有し、非公式の日本語翻訳サイトを立ち上げてよいか確認しました。
ここで NG が出た場合は進められないため、前向きに検討いただけるよう、背景や課題、Tricentis 側のメリットを含め、できるだけ丁寧に伝えました。
具体的には、次のような内容です。
- 日本語ローカライズがされていないため、興味を持ってくれてもなかなか活用が進まないこと
- 困った時に手軽に確認できるドキュメントがないと、意思決定やトライアル、運用時の不安につながること
- 非公式でも日本語ドキュメントがあれば、 Testim の認知や活用拡大の一助になる可能性があること
このような交渉の結果、「制作していただけるのであれば、こちらとしてもありがたいです」と、無事に許諾のお返事をいただくことができました。(お返事をいただけていなかったら、そもそもこの記事は書けていませんが...)
2. 公開までのフローと運用方針の認識合わせ
無事に許諾をいただけたので、続いて公開までの約束事やフロー、公開後のドキュメント運用方針について整理しました。
今回は契約が発生しない個人の活動ということもあり、以下のような流れで進めることを双方で合意しました。
- 日本語翻訳サイトは非公式であり、公式とは直接関係ないことが分かるようにすること
- サイト公開前に Tricentis Japan 様のレビューを挟むこと
- いつまでに公開する、といった明言はしないが、レビュー可能な段階でデプロイURLを共有すること
- 公開後のドキュメント更新はベストエフォートで対応すること
3. サイトを制作
約束事やフローの整理、共通認識のすり合わせが完了したので、実際にサイト制作をはじめました。制作時は AI 支援も受けながら進めています。
AIとの協働で苦労したこと
AI を活用しつつも、以下のように「要件を定義するための問い」を考え、AI に正しく伝わるよう言語化していく作業には、個人的に苦労しました。
-
どのようなデザインにするべきか?
- サイト全体のレイアウト
- ユーザー導線や視認性(サイドバーの有無、目次の配置、フォントの種類やサイズ)
-
公式と遜色ない使い勝手にするには、どんな機能が必要か?
- 目的の記事を探しやすくする「ドキュメント検索機能」
- 記事を読みやすくするための「コールアウト(注釈ブロック)」や「コードスニペットのハイライト」対応
-
どの技術を使って制作するのがベストか?
- ドキュメントサイトに適したフレームワークの選定
- 使用する言語、CSS、ライブラリの組み合わせ
-
運用保守を見据えた設計はどうあるべきか?
- 新規ページの追加や、既存ドキュメントの更新のしやすさ
- 画像や動画の管理方法
- 公式の英語ドキュメントが更新された際の検知方法
- 公式ドキュメントと翻訳ドキュメントの整合性を確認するフロー
実際に利用するユーザー目線での使いやすさと、それを実現・運用する開発者目線の両方で考える必要があり、自分の持っている知識や情報をベースに AI と壁打ちしながら進めていきました。
結果的には、公式ドキュメントの構成やレイアウトに近い形で、ユーザーが違和感なく利用できるようなサイトを目指して制作しました。
採用技術と選定意図
悩んだ末に SSG(Static Site Generation)レンダリング方式を軸に考え、 Astro + TypeScript + Tailwind CSS + Markdown + Vercel の構成で制作しました。
この構成を採用した主な理由は以下の通りです。
-
表示速度と安定性:
- ドキュメントサイトにおいて最も重要な「情報の引き出しやすさ」を優先するため、
SSGによる高速な静的ページ配信を採用しました。
- ドキュメントサイトにおいて最も重要な「情報の引き出しやすさ」を優先するため、
-
ミニマムだけどパワフル:
- 必要以上に肥大化せず、
Astroの設計が今回のサイト制作の目的に最適と判断しました。
- 必要以上に肥大化せず、
-
Zero JS による圧倒的な軽量化:
- ブラウザへの負荷を最小限に抑え、モバイル環境でもストレスなく閲覧できるようにしたいこともあり、
Astroの特徴である「必要な部分だけJavaScriptを送る(Islands Architecture)」仕組みを利用するのが今回は最適だと考えました。
- ブラウザへの負荷を最小限に抑え、モバイル環境でもストレスなく閲覧できるようにしたいこともあり、
-
Markdown ベースの運用保守性:
- 記事を
Markdownで管理することで、ドキュメントの追加・修正がGitのワークフローに馴染みやすく、長期的な運用負荷を抑えられると考えました。 - ヘッドレスCMSの利用も検討したのですが、ローカルに記事を配置する方が AI がファイルを扱いやすく親和性が高いと判断し、今回はプロジェクト内に記事コンテンツを配置する構成にしました。
- 記事を
-
Vercel による簡単なデプロイとプレビュー環境:
-
GitHubと連携した自動デプロイや、プルリクエストごとのプレビュー環境を非常に簡単に構築できること、他のプロジェクトでも利用していたこともあり、ホスティングはVercelを採用しました。
-
4. 制作したサイトのレビュー
制作がある程度完了した段階で、Tricentis Japan 様にレビューをしていただき、いただいたフィードバックの内容を修正しました。事前にすり合わせをしていたこともあり、大きなフィードバックはあまりなく、細かな修正で進めることができました。事前のすり合わせの重要性を改めて感じるとともに、修正が軽微に済んで安心しました。
5. サイトを公開
レビューでいただいたフィードバックを修正し、再レビューを経て公開の許可も出たため、サイトを公開しました。
(公開当初は一部ドキュメントのレイアウトが崩れていたり、すべてのページを翻訳しきれていなかったり、バグがあったりしたので、公開後も水面下で少しずつ修正を続けていましたが...)
さいごに
筆者はこれまで、ある程度自信を持って公開できるようなポートフォリオを制作できた経験があまりなかったこともあり、本当にやりきれるのかとても不安でしたが、AI の支援も受けつつ、どうにか公開まで進めることができました。嬉しさよりも、まずは無事に作りきれてホッとしている、というのが正直なところです。
そして今回の制作を通じて、ユーザー目線や技術面をはじめ、著作権の考え方や進め方など、多くの学びを得ることができたので、やって良かったと感じています。また、公開後はあまり宣伝していなかったのですが、雑談で他チームの方とお話した際に「え!?制作者だったんですか!?見てました!」などと言われることがあり、見てくださっている方がいることに驚いたと同時にとても嬉しく、制作して良かったと感じています。
元々は社内で利用するために制作をはじめたのですが、せっかくなら公開する方が、同じ悩みを持っている方々の助けになるのではないかと感じ、公開に踏み切りました。
今後、Tricentis Testim のトライアルや導入を検討される際に、どんなことができるのか、機能設定をどう進めればよいのかなど、困った時にご活用いただけたら、とても嬉しく思います。
参考