概要
GCPを触っていて、ドキュメント(documentation)とレファレンス(reference)の違いがわからなかった。
日本語で調べても出てこなかったので英語から。
Documentationとは
公式が発行しているもの。
取扱説明書的なものだと理解した。
ライブラリのドキュメントとは、これをさす。
Referenceとは
API Referenceのこと。API用の取扱説明書だと理解。
Documentationの一種とも見なすことができる。つまり、APIのDocumenationをさすと理解した。
特に、使用例はなく、APIのメソッドやクラスについて、構造的に、体型的に説明したものが多いらしい。
- API = Application Programming Interface。
そもそも
APIとライブラリは違う。
API = それ単体で動くもの。既存のシステムを簡単に動かすことができるようになる。
ライブラリ = 関数やクラスをディレクトリにまとめたもの。