SDK開発者として
GoogleMapsのリファレンスが素晴らしい。
https://developers.google.com/maps/documentation/javascript/?hl=ja
文章でダラダラ書くのではなく、
まず最優先でコードありきで、少しの補足がおまけ程度に付けてまとめてある。
言葉がたくさん必要なSDKってそもそも設計が良くないわけで、
SDK提供者側は、コード見たら一発で分るレベルのAPIを用意すべき。
その点でGoogleMapsAPIは洗練されてる。
世界中のアプリ開発者の人の目に晒されてるからかも。
あと、リファレンス内のコードが見やすく整形されてるってのも良い。
細かいことだけどアプリ開発者から見た時の印象が違う。
現状、HTML,CSS,Javascript関連に疎いエンジニアが、
副産物としてドキュメンテーションしてるんだけど、
この環境は非常に良くない。
ドキュメンテーションに対する意識を高めて、
もっとフレームワークを洗練させて、
SDKを使う人の立場にたった洗練されたものを提供すべきだと思った。
さすがにsdkのデモとかはしっかり作ってるけど、
リファレンスではHTMLコードベタ張りとかが横行してる世界、ヨクナイ。
改善しよう!
https://developers.google.com/maps/documentation/javascript/?hl=ja
文章でダラダラ書くのではなく、
まず最優先でコードありきで、少しの補足がおまけ程度に付けてまとめてある。
言葉がたくさん必要なSDKってそもそも設計が良くないわけで、
SDK提供者側は、コード見たら一発で分るレベルのAPIを用意すべき。
その点でGoogleMapsAPIは洗練されてる。
世界中のアプリ開発者の人の目に晒されてるからかも。
あと、リファレンス内のコードが見やすく整形されてるってのも良い。
細かいことだけどアプリ開発者から見た時の印象が違う。
現状、HTML,CSS,Javascript関連に疎いエンジニアが、
副産物としてドキュメンテーションしてるんだけど、
この環境は非常に良くない。
ドキュメンテーションに対する意識を高めて、
もっとフレームワークを洗練させて、
SDKを使う人の立場にたった洗練されたものを提供すべきだと思った。
さすがにsdkのデモとかはしっかり作ってるけど、
リファレンスではHTMLコードベタ張りとかが横行してる世界、ヨクナイ。
改善しよう!