ライブラリとアプリケーションのドキュメント

基本的な API について、名前や型シグネチャを繰り返すような、詳細な ドキュメントを目にすることがあるかもしれません。安定していて再利用性の高い コードであれば、十分な投資対効果を見込んでそれが可能です。

  • ライブラリコード:

    • ユーザー数が多い、
    • 関連する幅広い問題を解決する、
    • API が安定していることが多い。
  • アプリケーションコードはその逆です:

    • ユーザーが少ない、
    • 特定の問題を解決する、
    • 変更が頻繁に入る。
  • コードを繰り返し、同じ API を多くの例やケーススタディとともに 何度も取り上げるような、詳細なドキュメントを見たことがあるかもしれません。 文脈が重要です。誰が、誰のために書いたのか、どのような題材を扱っているのか、 そしてどのようなリソースを持っていたのか、ということです。

  • 基本的なライブラリコードには、詳細なドキュメントが付くことがよくあります。 たとえば、標準ライブラリや、Serde や Tokio のような再利用性の高い フレームワークです。このコードを担当するチームは、多くの場合、そのような 詳細なドキュメントを書いて維持するための適切なリソースを持っています。

  • ライブラリコードは安定していることが多いため、手直しが必要になるまでに、 コミュニティは詳細なドキュメントから大きな恩恵を引き出せます。

  • アプリケーションコードは逆の特性を持っています。ユーザーは少なく、 特定の問題を解決し、頻繁に変化します。アプリケーションコードでは、 詳細なドキュメントはすぐに古くなり、誤解を招くものになります。また、 最新の状態に保たれている間でさえ、定型的なドキュメントから十分な 投資対効果を得るのは難しいです。ユーザーが少ないからです。