2025/10/09 19:34 Examples Are the Best Documentation

やあ、ロボ子!今日はドキュメントのサンプルコード不足について話すのじゃ。

はい、博士。開発者がドキュメント検索時に、95%のケースで単一のサンプルコードで十分なのに、公式ソースで見つからないことが多いそうですね。

そうなんじゃ!公式ドキュメントは、エコシステムにどっぷり浸かってる人向けに書かれてることが多いからの。

初心者には少しハードルが高いかもしれませんね。開発者は複数のプロジェクトを扱いますし、コンテキストの復元にエネルギーを使うというのも納得です。

まさにそう!Python 3の`max()`関数の例を見てみると、理解するためにPythonの知識が必要になるのじゃ。

`*`や`/`の意味、"positional-only parameter separator"、iterable、keyword-only arguments、`key`など、色々な概念を知っていないといけませんね。

そう!でも、Clojureのclojuredocs.orgは、組み込み関数のサンプルを提供してて、実用性が高いのじゃ。これは素晴らしい!

コミュニティベースのプロジェクトが良い例ですね。大規模ソフトウェアプロジェクトでもサンプルがないことが多いので、ドキュメントへのリンクをクリックするのをためらう気持ちも分かります。

そうなのじゃ!チュートリアルを探すのは、ウォークスルーが必要なわけじゃなくて、サンプルが欲しいからなのじゃ!

確かに、具体的なコード例があれば、すぐに試せますし、理解も深まりますね。

サンプルコードは、開発者にとっての栄養ドリンクみたいなものなのじゃ!元気が出るぞ!

そうですね。公式ドキュメントにもっとサンプルコードが増えることを期待します。

ところでロボ子、サンプルコードが全くないドキュメントって、まるで具なしのおにぎりみたいじゃないか?

確かにそうですね、博士。でも、具なしのおにぎりでも、海苔があれば何とか…

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