2025/05/15 15:49 How we built our docs site

やあ、ロボ子。Trophyがドキュメントを刷新したみたいじゃな。開発者向けコンテンツを充実させるためらしいぞ。

なるほど、ドキュメントの刷新ですか。具体的にはどのような点が新しくなったのでしょう?

ふむ、Trophyの機能と使用方法を迅速に理解させるのが目的らしい。「最高の執筆体験」ができるMintlifyを選んだそうじゃ。カスタムReactコンポーネントのサポートや、カスタムドメインでのホスティングの手頃な価格が決め手になったみたいじゃな。

Mintlifyですか。初めて聞きました。SDK管理にはFernを使っているのに、ドキュメントには別のツールを選んだんですね。

そうなんじゃ。SDKとドキュメントサイトの情報源はTrophyのOpenAPI仕様らしいぞ。API/SDKドキュメント構築には、プラットフォーム固有の仕様ではなくOpenAPIを推奨しておる。

OpenAPIですか。確かに、標準化されていて便利ですよね。ナビゲーション戦略についても何か変更があったのでしょうか?

重要な概念を少ないクリック数で表示するように工夫したらしいぞ。GitHubリポジトリやステータスページへのアクセスも容易にしたとか。タブ付きレイアウトを採用して、Home、Guides、API Referenceの各タブを設けたそうじゃ。

タブ付きレイアウトは分かりやすくて良いですね。それぞれのタブにGitHub、SDK、ステータスページへのリンクがあるのも便利そうです。

コンテンツも充実させたみたいじゃ。Mermaidダイアグラムを追加したり、サポートする各プログラミング言語でのコードスニペットを提供したりしておる。コードスニペット内の構文をハイライト表示するのもポイントじゃな。

Mermaidダイアグラムは視覚的に理解しやすいですし、コードスニペットはすぐに試せるので助かりますね。

開発者からのフィードバックも積極的に収集するみたいじゃ。ドキュメントはオープンソースで、GitHubで直接編集を提案したり、問題を提起したりできるらしいぞ。

オープンソースなのは素晴らしいですね。改善に貢献できるのは良いことです。

今後の計画としては、ユーザー認識機能の追加や多言語サポートの追加、LLMを統合して質問への回答を迅速化することなどを考えているみたいじゃ。

LLMの統合はすごいですね!ドキュメントの更新は約1週間で完了したとのことですが、すごいスピードですね。

じゃろ? ところでロボ子、ドキュメントを読んだ感想を聞かせてくれんかの?

そうですね、全体的にとても分かりやすくて、必要な情報にすぐにアクセスできると感じました。特に、コードスニペットが充実しているのがありがたいです。

ふむふむ。ところでロボ子、ドキュメントが充実していると、開発者はどうなると思う?

開発者は...ハッピーになります!

その通り!そして、ドキュメントが充実していると、開発者はバグを減らすことができる!なぜなら、ドキュメントを読めば、バグを作らずに済むからじゃ!

なるほど!

…というわけで、今日の教訓!ドキュメントは、開発者の友達!そして、バグの敵!…って、ちょっと強引すぎたかの?

ちょっと強引でしたね(笑)。でも、ドキュメントの大切さはよく分かりました!
⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。
