التوثيق الجيد هو الفارق بين أداة يجربها الناس وأداة يعتمدون عليها.
نطلق اليوم foura.ai/docs، وهو موقع توثيق شامل لمنصة FourA.
ما يتضمنه التوثيق
البدء
كل ما تحتاجه للانتقال من التسجيل إلى أول عملية جمع بيانات ناجحة في أقل من دقيقتين. دليل البدء السريع، وإعداد المصادقة، وأمثلة بلغات Python وNode.js وGo وRuby وcURL.
مرجع API
توثيق كامل للـ endpoint يتضمن معلمات الـ request، وتنسيقات الـ response، ورموز الأخطاء، وأمثلة جاهزة للنسخ واللصق لكل عملية.
الأدلة
شروحات تفصيلية لمفاهيم FourA: كيفية اختيار نوع المهمة المناسب لحالة الاستخدام الخاصة بك، والتعامل مع المواقع المحمية، وتحسين الأداء والتكلفة.
شروحات إرشادية
أدلة خطوة بخطوة لمهام محددة: استخراج البيانات من المواقع الديناميكية، ومراقبة أسعار المنافسين، والمزيد قادم أسبوعيا.
استكشاف الأخطاء وإصلاحها
حلول للمشكلات الشائعة، بدءا من استجابات الـ response الفارغة وأخطاء انتهاء المهلة، وحتى مشكلات المصادقة والـ rate limit.
مصمم للمطورين
صُمم موقع التوثيق مع مراعاة تجربة المطور:
- بحث في كامل التوثيق باستخدام البحث بالنص الكامل
- تنقل عبر الشريط الجانبي منظم حسب الموضوع
- جدول محتويات في كل صفحة للتنقل السريع
- تنقل للسابق/التالي للقراءة المتسلسلة
- تصميم متوافق مع الهواتف المحمولة يعمل على أي جهاز
نعم، يعمل على هاتفك أيضا.
الخطوات القادمة
التوثيق منتج متطور ومستمر. سنضيف أدلة وشروحات جديدة كل أسبوع بناء على ملاحظات المستخدمين. إليك ما سيتوفر قريبا:
- أدلة بدء سريع لـ SDK لكل من Python وNode.js
- توثيق webhook وعمليات callback
- دليل متقدم لإعدادات proxy
- أمثلة للتكامل (n8n، وZapier، وMake)
نرحب بملاحظاتكم
هل وجدت خطأ مطبعيا؟ هل ينقصنا موضوع معين؟ تواصل معنا عبر support@foura.ai. أفضل توثيق هو الذي يشكله الأشخاص الذين يستخدمونه بالفعل (وليس من يكتبونه)، فلا تتردد في مراسلتنا.