الدرس 2 من 6

قراءة وتحليل مستندات بنية البرمجيات

قراءة وتحليل مستندات بنية البرمجيات

12 دقيقة للقراءة

كمهندس برمجيات أول أو قائد ضمان جودة، ستقضي وقتاً كبيراً في قراءة ومراجعة وتقديم ملاحظات على المستندات التقنية. يغطي هذا الدرس أنواع المستندات الرئيسية والعبارات الإنجليزية ومهارات القراءة النقدية.

1. مستندات RFC الهندسية

RFC هو اقتراح مكتوب رسمي لتغيير تقني كبير.

الأقسام الرئيسية وعباراتها

القسم العبارات الرئيسية
الملخص "This RFC proposes...", "This document describes..."
الدافع "The current approach suffers from...", "This is motivated by..."
التصميم "The proposed solution is to...", "We will implement this by..."
البدائل "We considered X but rejected it because..."
المخاطر "The main drawback is...", "This introduces risk in..."

كلمات RFC 2119 المفتاحية

الكلمة المعنى القوة
MUST متطلب مطلق إلزامي
SHOULD توصية قوية؛ الانحراف يتطلب تبريراً مُوصى به
MAY اختياري حقاً اختياري

2. سجلات القرار المعماري (ADR)

مستند قصير يسجل قراراً معمارياً واحداً مع سياقه وعواقبه.

القسم العبارات الشائعة
السياق "We are facing...", "Due to increasing scale..."
القرار "We will adopt...", "We have decided to..."
العواقب "As a result...", "The trade-off is...", "We accept that..."

الفرق بين ADR وRFC

الخاصية ADR RFC
الطول 1-2 صفحة 5-20+ صفحة
النطاق قرار واحد اقتراح كبير متعدد القرارات
الغرض تسجيل ما تم تقريره ولماذا اقتراح ومناقشة حل

3. مقترحات المشاريع مفتوحة المصدر

المشروع النوع العبارة المميزة
Rust RFC "This RFC proposes stabilizing the X feature..."
Python PEP "This PEP introduces syntax for..."
JavaScript TC39 Proposal "This proposal has advanced to Stage 3..."

مراحل TC39

المرحلة الاسم المعنى
0 Strawperson مجرد فكرة
1 Proposal المشكلة والحل محددان
2 Draft مواصفات أولية مكتوبة
3 Candidate المواصفات مكتملة
4 Finished جاهز للإدراج في المعيار

4. مستندات التصميم (أسلوب Google)

الأقسام الحرجة

  • Goals (الأهداف): ما يبدو عليه النجاح
  • Non-Goals (غير الأهداف): "This document does NOT address..." — تحديد صريح للنطاق
  • Alternatives Considered (البدائل المدروسة): مقارنة عادلة مع مقايضات مُحددة
  • Cross-Cutting Concerns (الاهتمامات المشتركة): الأمان، الخصوصية، المراقبة، الاختبار

5. مستندات استراتيجية الاختبار

القسم المفردات الرئيسية
النطاق "in scope", "out of scope", "test boundaries"
بوابات الجودة "quality gates", "release criteria", "exit criteria"
تقييم المخاطر "high-risk areas", "regression risk", "blast radius"
إدارة العيوب "severity classification", "triage process", "escape analysis"

عبارات تقارير الجودة

  • "The escape rate has decreased by 30%." (معدل الأخطاء التي تصل للإنتاج)
  • "We achieved 85% mutation score." (فعالية الاختبارات)
  • "All quality gates passed for the release candidate." (جاهزية الإصدار)

6. مدونات الهندسة

عبارات التحليل النقدي

  • "The paper argues that... but I think this overlooks..."
  • "This approach is well-suited for large-scale systems."
  • "The key takeaway from this article is..."
  • "This aligns with / contradicts what we've seen."

7. عبارات اليقين والتحفظ

العبارة مستوى اليقين
"X guarantees Y" مطلق
"X ensures Y" عالٍ جداً
"X is expected to Y" عالٍ لكن غير مضمون
"X should Y" مُوصى به
"X may Y" محتمل

سير عمل القراءة

  1. تصفح أولاً: اقرأ العنوان والملخص والأهداف وغير الأهداف
  2. حدد نوع المستند: RFC، ADR، مستند تصميم، أو استراتيجية اختبار
  3. اقرأ قسم البدائل بعناية: يكشف عمق تحليل المؤلف
  4. ابحث عن الافتراضات غير المُعلنة: ما الذي يعتبره المستند مُسلّماً به
  5. تحقق من العواقب والمقايضات: هل هي صادقة وكاملة

التالي: العروض التقنية والتحدث أمام الجمهور

:::

اختبار

اختبار قراءة وتحليل مستندات بنية البرمجيات

خذ الاختبار