優れたドキュメントは、単に試されるだけのツールと、実際に導入されるツールの決定的な違いとなります。
本日、FourA プラットフォームの完全なドキュメントサイト foura.ai/docs を公開しました。
含まれるコンテンツ
はじめに
アカウント登録から2分未満で最初のデータ収集を成功させるために必要なすべてを網羅しています。クイックスタートガイド、認証設定、および Python、Node.js、Go、Ruby、cURL によるサンプルコードを提供します。
API リファレンス
全 endpoint の詳細ドキュメント。request パラメータ、response 形式、エラーコード、すべての操作に対応したコピー＆ペースト可能なサンプルを含みます。
ガイド
FourA の概念を深く解説。ユースケースに応じた最適なタスクタイプの選択方法、保護されたサイトの処理方法、パフォーマンスとコストの最適化手法を説明します。
ハウツーチュートリアル
特定タスクのステップバイステップ手順。動的ウェブサイトのスクレイピングや競合価格のモニタリングなどを掲載しており、毎週さらに追加予定です。
トラブルシューティング
空の response やタイムアウトエラーから、認証の問題、rate limit まで、一般的な問題の解決策を記載しています。
開発者のための設計
開発者体験を重視して設計されています。
- 全文検索によるドキュメント全体の検索
- トピック別に整理されたサイドバーナビゲーション
- 素早くジャンプできる各ページの目次
- 順を追って読み進められる前へ/次へナビゲーション
- あらゆるデバイスで快適に動作するモバイル対応レイアウト
スマートフォンでも問題なく閲覧可能です。
今後の予定
ドキュメントは常に更新されるプロダクトです。ユーザーからのフィードバックをもとに、新しいガイドやチュートリアルを毎週追加していきます。近日公開予定の項目は以下の通りです。
- Python および Node.js 向け SDK クイックスタート
- webhook およびコールバックのドキュメント
- 高度な proxy 設定ガイド
- 連携例（n8n、Zapier、Make）
フィードバックの受付
誤字の発見や不足しているトピックがございましたら、support@foura.ai までご連絡ください。最高のドキュメントは、（作成者ではなく）実際に利用する開発者によって形作られます。忌憚のないご意見をお待ちしています。