APIドキュメントへのリンクの貼り方
どこのIT企業でも通常は社内Wiki(コンフルエンスなど)があり、そこにはプロダクトの概要や使用しているAPIドキュメントへのリンクが貼られていることが多い。
ここでひとつ注意しなければならないことがある。それはAPIドキュメントへのリンクは普通に貼ってはならないということだ。
例えばAngularJSを使用していてAPIドキュメントのリンクを普通にこのように貼っていたとする。
https://docs.angularjs.org/api
これのどこに問題があるかというと、このリンク先は最新のAPIドキュメントへのリンクだということだ。
そのため開発当初はAngularJS 1.3.15を使っていたとしても、リンク先のAPIドキュメントの内容はバージョンが上がるたびに最新の内容に次々に置き換わってしまう。(AngularJSの場合、上記のリンクはRC(1.4.0-rc)だという別の問題も)
なのでAPIドキュメントのリンクを貼り付ける場合はそのバージョンのリンク先をこのように貼ったほうが良い。(AngularJSの場合はバージョンが少し違うことで特定のコードが動かなくなることもあるので特に重要)
https://code.angularjs.org/1.3.15/docs/api
