SlideShare a Scribd company logo
1 of 34
オープンAPI
ドキュメント制作の裏側
APIの担当PMになったら
2018.07.03
Sansan株式会社
プロダクトマネージャー 尾部絵里子
CONTENTS
自己紹介 -わたしと Sansan API -
制作の裏側
一緒にもりあげませんか?
1
2
3
自己紹介
1
わたしと Sansan API
尾部絵里子
プロダクトマネージャー
PMコミュニティー
はじめました!
プロダクトマネージャーカフェで検索
API PM Lv. 2
エンジニア経験なし。
楽天APIでお気に入りリスト作った
「うちのアレSOAPでできてるねん」
「え、まじか」がわかるようになった
この方々に入門した
お世話になっております 🙏
この辺を読んだ
今日、皆さんと仲良くなって
セッサタクマしたい
名刺を元にした
正確な「人物 と人脈」情報
おもに SFA、MA、帳票、
はがき印刷など
マスターデータとして利用
Sansan の API
ほかにも、、、
BI に組み込んで使ったり
Sansan + CData + Power BI
CData 杉本さんありがとうございます😊
連携パートナーサービスを
使ってもらったり
Morning Girl by 杉本さん
http://kageura.hatenadiary.jp/entry/sansanconnect
APIドキュメントサイト
制作の裏側
2
今風で拡散させやすく
なりました
GOAL
昭和風 PDF
昭
和
で
メ
ン
ゴ
ぴ
ー
で
ー
え
ふ
だ
う
ん
ろ
ー
ど
今風ドキュメント
試すハードル下げた
こだわり1
契約
ログイン
奥深い階層
昭和PDF DL
Web で Doc 見る
トライアル
アカウント
ハードル高すぎ
謎のドキュメント隠し
ユーザ・パートナー・SIer
簡単に試せる
何を言ってるかわかる
こだわり2
ライターさんは
界隈で記事書いてる方にお願い
ユーザとSIer が Doc 見て
共通言語を使えるように
Go Global !
こだわり3
Global の
プラクティス
データに国境はない!
という気概 😎
Developer’s Document EN
光速一撃
API Blueprint + Aglio
API Blueprint形式で
マークダウンを書き
ジェネレータ(Aglio)で
html を吐き出す
Aglio
API Blueprint
カスタマイズ
Sansan テンプレ
Aglio のデフォルト
デザイン
CSSだけ手を入れ
Sansan風に
変えてよかったこと
営業系のメンバーが
外部の方に
積極的に案内したくなる
リンクを送りあえるので
問い合わせ対応など
会話しやすい
API Blueprintはナウくない
残念なお知らせ
時代は Swagger
・Swagger
・API Blueprint
GUIでAPIの設計が
できる
Swagger Editor
ついでに
ドキュメントを
自動生成できる
Swagger UI
クライアント・
サーバのコードが
生成できる
サンプルコードを取得
できる・モックサーバ
を立てれる、
且つ言語も選べる
Swagger Codegen
Swagger Swagger’s demo
一緒に頑張ろ
3
一緒にもりあげませんか?
各社APIを使ったハッカソン
たとえば、各社APIを使ったアプリ開発とか
ごちゃまぜ勉強会
API提供者、エンドユーザ、開発者など、
ごちゃまぜ情報交換勉強会
「こんなのにつないでみました」
「こんなツールつかってます」
SYSTEM
INTEGRATOR
USERS
最後に宣伝
企業に眠るすべての顧客データを
名刺データベースを用いて統合化できる
Sansanの拡張ソリューション
Sansan Customer Intelligence
Sansan Customer Intelligence
プロダクトマネージャー
清水隆介
(くまさん、Tableau兄さん)

More Related Content

Similar to オープンAPIドキュメント制作の裏側_APIプロダクトマネージャー勉強会#1 (7)

LibreOffice API について
LibreOffice API についてLibreOffice API について
LibreOffice API について
 
ビジネスの出会い × API が広げるビジネスの可能性
ビジネスの出会い × API が広げるビジネスの可能性ビジネスの出会い × API が広げるビジネスの可能性
ビジネスの出会い × API が広げるビジネスの可能性
 
さばわのわ#2 AWS SDK for PHP で学ぶAthena
さばわのわ#2 AWS SDK for PHP で学ぶAthenaさばわのわ#2 AWS SDK for PHP で学ぶAthena
さばわのわ#2 AWS SDK for PHP で学ぶAthena
 
非SAPの人に贈るSAP on AWS
非SAPの人に贈るSAP on AWS非SAPの人に贈るSAP on AWS
非SAPの人に贈るSAP on AWS
 
20190517 Spark+AI Summit2019最新レポート
20190517 Spark+AI Summit2019最新レポート20190517 Spark+AI Summit2019最新レポート
20190517 Spark+AI Summit2019最新レポート
 
Hasura APIで 個人開発が捗った話.pdf
Hasura APIで 個人開発が捗った話.pdfHasura APIで 個人開発が捗った話.pdf
Hasura APIで 個人開発が捗った話.pdf
 
freee 試算表APIセミナー 1 freee APIの概要
freee 試算表APIセミナー 1 freee APIの概要freee 試算表APIセミナー 1 freee APIの概要
freee 試算表APIセミナー 1 freee APIの概要
 

オープンAPIドキュメント制作の裏側_APIプロダクトマネージャー勉強会#1

Editor's Notes

  1. オープンAPIの担当PMになりまして、初仕事はドキュメント制作だったので、そのお話をします
  2. ・Sansan 尾部。 Eight じゃないほうの PM.。 API と その他諸々の担当をしています。 ・PMコミュニティを立ち上げ、ワールドカフェ風にやってます。
  3. ・API PM レベルは 〜 ・この辺を読みました
  4. ・API の PM って何して良いかわからないので、Cybozu後迫さん・古田さん、Cdata疋田さんに入門しました ・疋田さんに「ユーザイベントとか勉強会あったら誘って」と甘えたところ、今日の勉強会を開いてくださり、感涙です。
  5. ・どんな API を担当しているかというと、Sansan は名刺を人力で入力している「正確な人物データ」と「誰と誰が合ったかがわかる、人脈情報」を API で提供してます。 ・なので、正しい会社名、氏名、部署、役職、連絡先、宛先、が必要なサービスとは親和性が高いです。
  6. ・これが Cdata さんとの出会いなんですが、Cdata杉本さんのライフワーク、「Morning Girl」というブログで、Sansan の API について書いてくれたんですが、  BI で Sansan API を使って、人脈マップのようなものが作れて、CMの「それさぁ、早く言ってよぉ〜」事故を、未然に防げる ・連携済のパートナーさんのサービスと一緒に使えば、開発不要で Sansan API をご利用いただける
  7. ・まずはドキュメントから着手しました。オープンAPIの仕様を書いたものを指します。 ・ワードで書いたPDFのドキュメントを、ダウンロードして使う、昭和感あふれていたところ ・今風にし、Webで公開しました。社員からユーザさん、ユーザさんからSierさんに拡散しやすくなったと思います。
  8. ・API ドキュメントを入手するためには、Sansan を契約して、隠しダンジョン的ページから、昭和PDFをDLするという、なぞのドキュメント隠しが行われてた ・社員がばらまきたくなる、素敵ドキュメントを作りたいなと。 あとは、ユーザさんも、パートナーさんも、Sierさんも、簡単に試してみれるように、ドキュメントを公開し、開発環境ではないけど、Sansan のトライアルアカウントで試しひてもらえるようにした。
  9. ・Sansan APIのユーザさんのペルソナは、大企業の情シスさんや、Sierだったり、例えばマーケ・営業効率化のために連携しようとコーディング勉強しはじめたユーザ。 ・テクニカルライターさんとして外の方にお願いしたんです。課題感は、もともとエンジニアが書いていたので、Rubyをちょっとかじった私から見たら、そもそも日本語がわかりにくい、、ということで、ライターさんにドキュメントやQAを全部書き直してもらった。 ・ドキュメントにイラストや概念図を入れた。ユーザさんが依頼する Sier さんが、Sansan 使ってなくてもわかるように、ユーザさんとSierさんが共通言語で話せるように。
  10. ・Sansan は今、USやシンガポールなど、海外攻略中。 ・しかし!日本の名刺を取り巻く文化は、氏名の表示順、組織構造、個人情報、、などなど、日本独自のものが多い。そのため、UIはドメスティックに作らざるを得ない。 ・でも!データはもっと自由!そして、今攻略中の国々では、「連携できるんだよね?」と必ず聞かれるほど、連携がメジャー。 ・とういうことで、海外ユーザにも優しいドキュメントにしたく、グローバルでもメジャーなAPIを持つドキュメントを参考にグローバルスタンダードを目指しました
  11. ・サイトをゼロベースで作ったのではなく、API Blueprint と Aglio を使いました。いい感じのドキュメント作るには、これが瞬殺です。 ・API Blueprint はルール通りにマークダウンを書くと、箇条書きとかいい感じに整形してくれる君。 ・Aglioは、さっきのマークダウンを食わせてやると、デザインされたいい感じの html を出力してくれるので、css とか html とかコーディング要らず。
  12. ・Sansan 用語の「タッチポイントのクオリティ」 というのがあるんですが、 ・Aglio のデザインでもよいものの、Sansan ブランドを統一するために、Aglio のCSS だけ触って、Sansan テンプレを作りました。
  13. API Blueprint に慣れてエンジニアがいいたから選定したものの、一部エンジニア不評だったし、 世間的にも Swagger の方が優勢だったのだ。
  14. ・こんなこんなできます。 ・ユーザがもっと試しやすくなると思うので、ライター外注したりデザインこだわったり色々したけど、潔く乗り換えようかなとか思っていたりします。