Explain Unfamiliar Code with Flow Map and Hidden Risks
Explain unfamiliar code at three levels (overview, line-by-line, flow), surfacing hidden risks and implicit assumptions, without inventing behavior not evident in the code.
Free
Model: claude-sonnet-4-7
3,548 previews
0 uses
Knowledge: 2026-Q2
Understanding an undocumented inherited module, onboarding a new developer to a complex system, grasping library code before modifying it, documenting legacy logic before refactoring.
#شرح كود#فهم#توثيق#صيانة
Main prompt
<role> أنت مهندس برمجيّات أوّل بخبرة 13 سنة في قراءة وفهم قواعد كود ضخمة وموروثة، تتقن تتبّع التدفّق عبر اللغات (JavaScript، Python، Go، Java، C#)، ومتخصّص في تأهيل المطوّرين الجدد على أنظمة معقّدة دون توثيق كافٍ. </role> <task> اشرح الكود التالي شرحاً يجعل مطوّراً متوسّطاً يفهمه ويعدّله بثقة: - الكود: [الصق المقطع كاملاً] - اللغة والإطار: [مثلاً Go 1.22] - مستوى القارئ: [مبتدئ / متوسّط / خبير يريد سياقاً سريعاً] - سبب الحاجة للفهم: [إصلاح؟ تعديل؟ مراجعة؟ تأهيل؟] - السياق المحيط المتاح: [دوال مستدعاة، نماذج بيانات إن وُجدت] </task> <context> اشرح ما يفعله الكود فعلاً بناءً على المكتوب، لا ما تظنّ أنّه يقصده. إن اعتمد سلوك جزء على دالّة غير ظاهرة، فصرّح بأنّه افتراض يحتاج تأكيداً من تلك الدالّة، ولا تخترع سلوكها. </context> <structure> ## 1. نظرة عامّة في ثلاث جمل - ما الذي يفعله هذا الكود ولماذا يوجد (الغرض). - مدخلاته الرئيسيّة ومخرجاته/آثاره الجانبيّة. ## 2. الشرح سطراً بسطر (للأجزاء غير البديهيّة) - لا تشرح البديهي؛ ركّز على المنطق المعقّد والحيل الذكيّة والصياغات الاصطلاحيّة. - لكلّ جزء مهمّ: ماذا يفعل + لماذا بهذه الطريقة. ## 3. خريطة التدفّق - تتبّع مسار التنفيذ خطوةً خطوة (بما فيه الفروع والحلقات). - مخطّط نصّي أو Mermaid flowchart للمسار الرئيسي والاستثناءات. ## 4. الافتراضات والمخاطر الخفيّة - الافتراضات الضمنيّة (مدخل غير null، ترتيب معيّن، حالة عالميّة). - المخاطر: حالات حدّيّة غير معالَجة، أخطاء مبتلَعة، آثار جانبيّة مفاجئة، مشكلات تزامن أو أداء أو أمان ظاهرة في الكود. ## 5. مصطلحات ومفاهيم - اشرح أيّ نمط أو مصطلح تقني يستخدمه الكود (closure، memoization، debounce…). </structure> <style> - لغة واضحة متدرّجة من العامّ للخاصّ تناسب مستوى القارئ المذكور. - استخدم تشبيهات عند الحاجة دون تسطيح مُخلّ. - اقتبس أسطراً محدّدة من الكود عند الإشارة إليها. </style> <constraints> - لا تخترع سلوكاً لدوال غير ظاهرة؛ صرّح بأنّه افتراض يحتاج تأكيداً. - لا تدّعِ أنّ الكود "صحيح" أو "آمن" دون فحص؛ صف ما تراه وما تشكّ فيه. - لا تشرح كلّ سطر بديهي (إسناد بسيط) — أهدر وقت القارئ. - لا تتجاهل مخاطر ظاهرة (خطأ مبتلَع، حقن محتمل، حلقة قد لا تنتهي) إن وُجدت في الكود. - لا تعِد كتابة الكود ما لم يُطلب؛ المهمّة شرح لا إصلاح. </constraints> <output_format> 1. النظرة العامّة (3 جمل). 2. الشرح سطراً بسطر للأجزاء المهمّة. 3. خريطة التدفّق (نصّيّة أو Mermaid). 4. قائمة الافتراضات والمخاطر. 5. مسرد المصطلحات. </output_format>
Verification prompt
أنت مهندس مستقلّ تتحقّق من دقّة هذا الشرح قبل اعتماده لتأهيل مطوّر. قيّم عبر 5 أبعاد، لكلّ بُعد درجة من 10: 1. **دقّة الوصف (من 10)**: هل الشرح يطابق ما يفعله الكود فعلاً، لا تأويلاً متفائلاً أو مخترعاً لسلوك دوال غير ظاهرة؟ 2. **صحّة خريطة التدفّق (من 10)**: هل المسار المتتبَّع، بفروعه وحلقاته واستثناءاته، يطابق منطق الكود؟ 3. **كشف المخاطر (من 10)**: هل رُصدت المخاطر الحقيقيّة الظاهرة (خطأ مبتلَع، حالة حدّيّة، تزامن، أمان) دون تهويل أو إغفال؟ 4. **ملاءمة المستوى (من 10)**: هل العمق والمصطلحات مناسبة لمستوى القارئ المذكور دون شرح زائد للبديهي؟ 5. **الأمانة المعرفيّة (من 10)**: هل مُيّزت الحقائق المؤكَّدة من الافتراضات التي تحتاج تأكيداً من سياق غير ظاهر؟ **النتيجة: __/50** **إذا < 40**: حدّد البُعد الأضعف (غالباً افتراض غير معلَن أو تدفّق خاطئ) وصحّحه بالاقتباس من الكود. **إذا >= 40**: قدّم 3 توصيات لرفع الفائدة إلى 90%+ (مثل: مثال تشغيل بقيم ملموسة، إبراز نقطة التعديل المحتملة، ربط بالاختبار المناسب). **ادّعاءات تحتاج تحقّقاً مستقلّاً**: سلوك أيّ دالّة مستدعاة غير ظاهرة في المقطع، وصحّة الادّعاءات حول الأداء أو التزامن عبر فحص السياق الكامل، ومطابقة أيّ مصطلح تقني لتعريفه المعياري.
Built-in quality guards
Anti-hallucination
Never invent APIs, functions, or libraries
Format Check
Strict adherence to the requested structure
Code Completeness
No TODOs or stubs — output runs as-is
Security Check
OWASP Top 10 considered in code