優れたドキュメントは、ツールを「試してもらう」か「使い続けてもらう」かの分かれ道となります。
本日、FourAプラットフォームの総合ドキュメントサイトであるfoura.ai/docsを公開します。
主なコンテンツ
クイックスタート
アカウント登録から最初のデータ収集を成功させるまで、2分未満で進めるために必要なすべてを解説しています。クイックスタートガイド、認証設定、そしてPython、Node.js、Go、Ruby、cURLのコード例を用意しています。
APIリファレンス
すべての操作に対応する、requestパラメータ、responseフォーマット、エラーコード、コピー＆ペースト可能なコード例を含む完全なendpointドキュメントです。
ガイド
FourAのコンセプトを深く掘り下げます。ユースケースに適したタスクタイプの選択方法、アンチボット対策の理解、パフォーマンスとコストの最適化について解説しています。
チュートリアル
特定のタスクを実行するためのステップバイステップのガイドです。動的ウェブサイトのスクレイピング、競合他社の価格監視などを掲載しており、毎週新しいガイドを追加予定です。
トラブルシューティング
空のresponseやタイムアウトエラーから、認証の問題、rate limitにいたるまで、一般的な問題への解決策をまとめています。
開発者のための設計
ドキュメントサイトは、開発者体験（DX）を重視して設計されています。
- 全文検索によるドキュメント全体の検索機能
- トピックごとに整理されたサイドバーナビゲーション
- 目的の場所に素早く移動できる、全ページの目次
- 順を追って読み進められる前後のナビゲーション
- あらゆるデバイスで動作するモバイルフレンドリーなレイアウト
スマートフォンからでも快適に利用できます。
今後の予定
ドキュメントは常に進化するプロダクトです。ユーザーのフィードバックに基づいて、新しいガイドやチュートリアルを毎週追加していきます。近日公開予定のコンテンツは以下の通りです。
- PythonおよびNode.js用のSDKクイックスタート
- Webhookおよびコールバックのドキュメント
- 高度なproxy設定ガイド
- 外部連携の例（n8n、Zapier、Make）
フィードバックをお待ちしています
誤字脱字の指摘や、不足しているトピックのリクエストなど、support@foura.aiまでお気軽にご連絡ください。優れたドキュメントは、執筆者ではなく、実際にそれを使用する人々によって形作られるものです。ぜひご意見をお寄せください。