التوثيق الواضح هو ما يفصل منصة البيانات القابلة للصيانة عن الهشة. هذا الدرس يغطي أنواع الوثائق الأساسية مع قوالب وأمثلة.
| القسم |
المحتوى |
| Overview (نظرة عامة) |
المالك، الجدول، اتفاقية الخدمة، الأهمية |
| Purpose (الغرض) |
ما السؤال التجاري الذي يجيب عليه المسار |
| Inputs (المدخلات) |
المصادر، الأنواع، التنسيقات |
| Transformations (التحويلات) |
ماذا تفعل كل خطوة ولماذا |
| Outputs (المخرجات) |
الأهداف، التنسيقات، الجداول |
| Dependencies (التبعيات) |
ما يجب أن يكتمل قبل وبعد |
| Error Handling (معالجة الأخطاء) |
الأخطاء الشائعة وخطوات الإصلاح |
| Runbook (دليل التشغيل) |
أوامر التشغيل اليدوي وإعادة الملء والتحقق |
"This pipeline processes raw sales transactions into
aggregated daily metrics."
هذا المسار يعالج معاملات المبيعات الخام إلى مقاييس يومية مجمعة
"If the source file is missing, the pipeline falls back
to the previous day's rates."
إذا كان الملف المصدر مفقوداً، يعود المسار لأسعار اليوم السابق
"To manually backfill, run: airflow dags trigger
daily_sales_etl --conf '{\"start_date\": \"2026-01-01\"}'"
لإعادة الملء يدوياً، شغّل: [الأمر]
| المكون |
المثال |
| Column name (اسم العمود) |
customer_status |
| Data type (نوع البيانات) |
VARCHAR(20) |
| Nullable (قابل للفراغ) |
لا |
| Description (الوصف) |
حالة دورة حياة العميل الحالية |
| Allowed values (القيم المسموحة) |
'active', 'churned', 'trial', 'suspended' |
| Business rules (قواعد الأعمال) |
'churned' = ألغى قبل أكثر من 30 يوم |
| Example (مثال) |
'active' |
| القسم |
المحتوى |
| Background (الخلفية) |
لماذا نحتاج هذا المخطط |
| Tables (الجداول) |
الغرض، الحبيبية، الحجم المتوقع |
| Relationships (العلاقات) |
الجداول الأب والابن ونوع العلاقة |
| Indexing Strategy (استراتيجية الفهرسة) |
الفهارس والأعمدة والغرض |
| Rollback Plan (خطة التراجع) |
كيفية العكس إذا حدث خطأ |
| العنصر |
التعريف |
| Schema Specification |
أسماء الحقول والأنواع والقيود |
| Quality Guarantees |
أهداف الاكتمال والتفرد والحداثة |
| Delivery SLA |
التكرار والموعد النهائي والتنسيق |
| Schema Change Policy |
فترة الإشعار وعملية التغييرات الكاسرة |
Summary (ملخص): التاريخ، المدة، الخطورة
Impact (التأثير): من تأثر وكيف
Timeline (الجدول الزمني): ماذا حدث ومتى
Root Cause (السبب الجذري): لماذا سمح النظام بحدوث هذا
Resolution (الحل): ما تم لإصلاح المشكلة الفورية
Prevention (الوقاية): تغييرات نظامية لمنع التكرار
| المرحلة |
الهدف |
| Assessment (التقييم) |
جرد المسارات والجداول والتبعيات |
| Foundation (الأساس) |
إعداد البيئة الهدف |
| Migration (الترحيل) |
ترحيل المسارات بالأولوية |
| Validation (التحقق) |
تشغيل النظامين بالتوازي ومقارنة النتائج |
| Cutover (التحويل) |
تحويل حركة الإنتاج وإيقاف القديم |
| الوثيقة |
الجمهور |
متى تُكتب |
| توثيق المسار |
المهندسون، المناوبون |
عند بناء مسار |
| قاموس البيانات |
المحللون، المهندسون |
عند إنشاء جداول |
| تصميم المخطط |
المعماريون |
قبل بناء نموذج بيانات |
| عقد البيانات |
بين الفرق |
عند مشاركة البيانات |
| تقرير الحادث |
جميع أصحاب المصلحة |
بعد كل حادث P1/P2 |
| خطة الترحيل |
الإدارة، المهندسون |
قبل أي تغيير منصة |
تهانينا! لقد أكملت جميع وحدات هذه الدورة. خذ الاختبار النهائي للحصول على شهادتك.
:::
