Recommended
More Related Content
Similar to オープンAPIドキュメント制作の裏側_APIプロダクトマネージャー勉強会#1
Similar to オープンAPIドキュメント制作の裏側_APIプロダクトマネージャー勉強会#1 (7)
Recently uploaded
Recently uploaded (9)
オープンAPIドキュメント制作の裏側_APIプロダクトマネージャー勉強会#1
- 2. CONTENTS 自己紹介 -わたしと Sansan API - 制作の裏側 一緒にもりあげませんか？ 1 2 3
- 5. API PM Lv. 2 エンジニア経験なし。 楽天APIでお気に入りリスト作った 「うちのアレSOAPでできてるねん」 「え、まじか」がわかるようになった
- 9. ほかにも、、、
- 10. BI に組み込んで使ったり Sansan + CData + Power BI CData 杉本さんありがとうございます😊 連携パートナーサービスを 使ってもらったり Morning Girl by 杉本さん http://kageura.hatenadiary.jp/entry/sansanconnect
- 14. 試すハードル下げた こだわり1
- 15. 契約 ログイン 奥深い階層 昭和PDF DL Web で Doc 見る トライアル アカウント ハードル高すぎ 謎のドキュメント隠し ユーザ・パートナー・SIer 簡単に試せる
- 16. 何を言ってるかわかる こだわり2
- 17. ライターさんは 界隈で記事書いてる方にお願い ユーザとSIer が Doc 見て 共通言語を使えるように
- 19. Global の プラクティス データに国境はない！ という気概 😎 Developer’s Document EN
- 20. 光速一撃 API Blueprint ＋ Aglio
- 24. 変えてよかったこと
- 28. GUIでAPIの設計が できる Swagger Editor ついでに ドキュメントを 自動生成できる Swagger UI クライアント・ サーバのコードが 生成できる サンプルコードを取得 できる・モックサーバ を立てれる、 且つ言語も選べる Swagger Codegen Swagger Swagger’s demo
- 29. 一緒に頑張ろ 3
- 30. 一緒にもりあげませんか？
- 32. ごちゃまぜ勉強会 API提供者、エンドユーザ、開発者など、 ごちゃまぜ情報交換勉強会 「こんなのにつないでみました」 「こんなツールつかってます」 SYSTEM INTEGRATOR USERS
- 33. 最後に宣伝
- 34. 企業に眠るすべての顧客データを 名刺データベースを用いて統合化できる Sansanの拡張ソリューション Sansan Customer Intelligence Sansan Customer Intelligence プロダクトマネージャー 清水隆介 (くまさん、Tableau兄さん）
Editor's Notes
- オープンAPIの担当PMになりまして、初仕事はドキュメント制作だったので、そのお話をします
- ・Sansan 尾部。 Eight じゃないほうの PM.。 API と その他諸々の担当をしています。 ・PMコミュニティを立ち上げ、ワールドカフェ風にやってます。
- ・API PM レベルは 〜 ・この辺を読みました
- ・API の PM って何して良いかわからないので、Cybozu後迫さん・古田さん、Cdata疋田さんに入門しました ・疋田さんに「ユーザイベントとか勉強会あったら誘って」と甘えたところ、今日の勉強会を開いてくださり、感涙です。
- ・どんな API を担当しているかというと、Sansan は名刺を人力で入力している「正確な人物データ」と「誰と誰が合ったかがわかる、人脈情報」を API で提供してます。 ・なので、正しい会社名、氏名、部署、役職、連絡先、宛先、が必要なサービスとは親和性が高いです。
- ・これが Cdata さんとの出会いなんですが、Cdata杉本さんのライフワーク、「Morning Girl」というブログで、Sansan の API について書いてくれたんですが、 BI で Sansan API を使って、人脈マップのようなものが作れて、CMの「それさぁ、早く言ってよぉ〜」事故を、未然に防げる ・連携済のパートナーさんのサービスと一緒に使えば、開発不要で Sansan API をご利用いただける
- ・まずはドキュメントから着手しました。オープンAPIの仕様を書いたものを指します。 ・ワードで書いたPDFのドキュメントを、ダウンロードして使う、昭和感あふれていたところ ・今風にし、Webで公開しました。社員からユーザさん、ユーザさんからSierさんに拡散しやすくなったと思います。
- ・API ドキュメントを入手するためには、Sansan を契約して、隠しダンジョン的ページから、昭和PDFをDLするという、なぞのドキュメント隠しが行われてた ・社員がばらまきたくなる、素敵ドキュメントを作りたいなと。 あとは、ユーザさんも、パートナーさんも、Sierさんも、簡単に試してみれるように、ドキュメントを公開し、開発環境ではないけど、Sansan のトライアルアカウントで試しひてもらえるようにした。
- ・Sansan APIのユーザさんのペルソナは、大企業の情シスさんや、Sierだったり、例えばマーケ・営業効率化のために連携しようとコーディング勉強しはじめたユーザ。 ・テクニカルライターさんとして外の方にお願いしたんです。課題感は、もともとエンジニアが書いていたので、Rubyをちょっとかじった私から見たら、そもそも日本語がわかりにくい、、ということで、ライターさんにドキュメントやQAを全部書き直してもらった。 ・ドキュメントにイラストや概念図を入れた。ユーザさんが依頼する Sier さんが、Sansan 使ってなくてもわかるように、ユーザさんとSierさんが共通言語で話せるように。
- ・Sansan は今、USやシンガポールなど、海外攻略中。 ・しかし！日本の名刺を取り巻く文化は、氏名の表示順、組織構造、個人情報、、などなど、日本独自のものが多い。そのため、UIはドメスティックに作らざるを得ない。 ・でも！データはもっと自由！そして、今攻略中の国々では、「連携できるんだよね？」と必ず聞かれるほど、連携がメジャー。 ・とういうことで、海外ユーザにも優しいドキュメントにしたく、グローバルでもメジャーなAPIを持つドキュメントを参考にグローバルスタンダードを目指しました
- ・サイトをゼロベースで作ったのではなく、API Blueprint と Aglio を使いました。いい感じのドキュメント作るには、これが瞬殺です。 ・API Blueprint はルール通りにマークダウンを書くと、箇条書きとかいい感じに整形してくれる君。 ・Aglioは、さっきのマークダウンを食わせてやると、デザインされたいい感じの html を出力してくれるので、css とか html とかコーディング要らず。
- ・Sansan 用語の「タッチポイントのクオリティ」 というのがあるんですが、 ・Aglio のデザインでもよいものの、Sansan ブランドを統一するために、Aglio のCSS だけ触って、Sansan テンプレを作りました。
- API Blueprint に慣れてエンジニアがいいたから選定したものの、一部エンジニア不評だったし、 世間的にも Swagger の方が優勢だったのだ。
- ・こんなこんなできます。 ・ユーザがもっと試しやすくなると思うので、ライター外注したりデザインこだわったり色々したけど、潔く乗り換えようかなとか思っていたりします。