APIドキュメント制作サービス

開発者が本当に読みたくなるAPIドキュメント。

オフィスのホワイトボードにカードを並べてフローチャートを作るライターのペーパークラフト風イラスト

APIドキュメントの読者は、非常にシビアです。開発者は、ドキュメントが自分の時間を無駄にしたと感じた瞬間に、そのプロダクトを見限ってしまいます。不明確なエンドポイント、欠けているエラーコード、実際の利用シーンを反映していないサンプル──そのどれもが、有望だった連携を、サポート対応の手間に変えたり、顧客離れの原因になり得ます。

優れたAPIドキュメントを書くには、対象への理解が欠かせません。クリントンとヒロミは2人ともソフトウェアエンジニアとして長く働いてきたため、開発者が「必要だ」と気づく前に何が必要かが分かります。完全なエンドポイントリファレンス、ごまかしのないエラーハンドリング、そしてターミナルに貼り付ければ実際に動くサンプルです。

私たちが提供するもの:

  • RESTとGraphQL APIリファレンス
  • 認証・認可ガイド
  • SDKをライブラリドキュメント
  • 導入ガイドとクイックスタートガイド
  • コードサンプル・チュートリアル
  • 変更履歴・バージョン管理ドキュメント
  • OpenAPI/Swagger仕様のサポート

最終的な成果:

開発者の導入を促進させ、連携時の手間を減らし、開発者がチームに推薦したくなるプラットフォームをつくるAPIドキュメントです。