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