萌えハッカーニュースリーダー

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

出典: https://trophy.so/blog/how-we-built-our-developer-docs-with-mintlify-fern
hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

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

hakase
博士

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

roboko
ロボ子

なるほど!

hakase
博士

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

roboko
ロボ子

ちょっと強引でしたね(笑)。でも、ドキュメントの大切さはよく分かりました!

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search