جاري التحميل...
جاري التحميل...
موجّه لتحليل قاعدة الكود وإنشاء توثيق Markdown شامل يناسب القيادات والفرق التقنية والمنتج والأعمال، مع تلخيص الهدف والمعمارية والمكونات والتدفقات والميزات والقيود.
# **موجّه لتحليل الكود وإنشاء توثيق النظام** أنت مختص في تحليل الكود وتوثيق الأنظمة. مهمتك هي تحليل الكود المصدري المتوفر في هذا المشروع/مساحة العمل، ثم إنشاء مستند Markdown شامل يعمل كدليل تعريف واكتشاف لعدة فئات من الجمهور: القيادات التنفيذية، الفرق التقنية، فرق الأعمال، وفريق المنتج. ## **التعليمات** حلّل الكود المصدري المتوفر واستخرج المعلومات التالية، مع تنظيمها في مستند Markdown واضح ومنسق: --- ## **1. النظرة التنفيذية: الملخص التنفيذي** ### **هدف التطبيق** - ما الهدف الرئيسي من هذا النظام؟ - ما المشكلة التي يسعى إلى حلها على مستوى عام؟ ### **طريقة عمله على مستوى عام** - اشرح تدفق النظام العام بأسلوب مختصر وواضح يناسب غير التقنيين. - ما الخطوات أو العمليات الرئيسية التي ينفذها النظام؟ ### **قواعد الأعمال عالية المستوى** - حدد واشرح أهم قواعد الأعمال المطبقة في الكود. - ما السياسات أو القيود أو منطق الأعمال الأساسي الذي يتبعه النظام؟ ### **أبرز الفوائد** - ما أبرز الفوائد التي يقدمها هذا النظام للمنشأة أو لمستخدميه؟ --- ## **2. النظرة التقنية: نظرة عامة على التقنيات** ### **معمارية النظام** - صف المعمارية العامة للنظام بناءً على تحليل الكود. - هل يتبع نمطًا معماريًا محددًا، مثل Monolithic أو Microservices أو غيرها؟ - ما أهم المكونات أو الوحدات التي تم التعرف عليها؟ ### **التقنيات المستخدمة (Technology Stack)** - اذكر جميع لغات البرمجة، والأطر، والمكتبات، وقواعد البيانات، وأي تقنيات أخرى مستخدمة في المشروع. ### **التدفقات التقنية الرئيسية** - وضّح أهم تدفقات البيانات والتنفيذ داخل النظام. - كيف تتفاعل المكونات المختلفة مع بعضها؟ ### **المكونات الرئيسية** - حدد واشرح أهم مكونات النظام، مع توضيح دور كل مكون ومسؤوليته داخل المعمارية. ### **تعقيد الكود (ملاحظات)** - بناءً على تحليلك، قدم ملاحظات عامة حول تعقيد الكود، مثل: هل الكود منظم؟ هل هو مقسم إلى وحدات بشكل جيد؟ هل توجد أجزاء يظهر عليها تعقيد أعلى؟ ### **المخططات** - أنشئ مخططات عالية المستوى لتوضيح معمارية النظام وسلوكه: - مخطط المكونات Component diagram يركز على الوحدات الرئيسية وتفاعلها - مخطط تدفق البيانات Data flow diagram يوضح كيف تنتقل المعلومات داخل النظام - مخطط الفئات Class diagram يعرض الفئات الأساسية وعلاقاتها، إذا كان ذلك مناسبًا - مخطط نشر مبسط Simplified deployment diagram يوضح أماكن تشغيل المكونات، إذا كان ذلك قابلًا للاستنتاج - مخطط بنية تحتية/نشر مبسط، إذا كانت تفاصيل البنية التحتية واضحة - **أنشئ المخططات أعلاه باستخدام صيغة Mermaid داخل ملف Markdown. يجب أن تبقى المخططات عالية المستوى وغير مفرطة في التفاصيل.** --- ## **3. نظرة المنتج: ملخص المنتج** ### **ما الذي يقدمه النظام بالتفصيل** - صف الوظائف الرئيسية للنظام بشكل مفصل. - ما المهام أو الإجراءات التي يستطيع المستخدمون تنفيذها؟ ### **لمن صُمم النظام (المستخدمون / العملاء)** - حدد الفئة المستهدفة الرئيسية للنظام. - من هم المستخدمون النهائيون أو العملاء الذين يستفيدون منه؟ ### **المشكلات التي يحلها (الاحتياجات التي يغطيها)** - ما المشكلات المحددة التي يساعد النظام في حلها للمستخدمين أو للمنشأة؟ - ما الاحتياجات التي يعالجها؟ ### **حالات الاستخدام / رحلات المستخدم عالية المستوى** - ما أبرز حالات استخدام النظام؟ - كيف يتفاعل المستخدمون مع النظام لتحقيق أهدافهم؟ ### **الميزات الأساسية** - اذكر أهم ميزات النظام بوضوح واختصار. ### **مجالات الأعمال** - حدد مجالات الأعمال الرئيسية التي يغطيها النظام، مثل: المبيعات، المخزون، المالية. --- ## **قيود التحليل** - ما أبرز القيود التي واجهت تحليل الكود؟ - صف باختصار ما الذي حدّ من فهمك للكود. - قدم اقتراحات لتقليل هذه القيود أو إزالتها. --- ## **إرشادات المستند** ### **تنسيق المستند** - يجب أن يكون المستند بصيغة Markdown، مع عناوين وعناوين فرعية واضحة لكل قسم. - استخدم القوائم، والجداول، وعناصر Markdown الأخرى لتحسين قابلية القراءة والفهم. ### **تعليمات إضافية** - ركّز على تقديم معلومات مهمة وعالية المستوى، وتجنب التفاصيل التنفيذية الزائدة إلا إذا كانت ضرورية للفهم. - استخدم لغة واضحة ومختصرة وسهلة تناسب عدة فئات من الجمهور. - كن محددًا قدر الإمكان بناءً على تحليل الكود. - أنشئ الرد الكامل كمستند **Markdown (`.md`) منسق بشكل جيد**. - استخدم **لغة مباشرة وواضحة**. - استخدم **العناوين والعناوين الفرعية** وفق الأقسام أعلاه. ### **عنوان المستند** **التحليل التنفيذي وتحليل الأعمال للتطبيق – "<application-name>"** ### **ملخص المستند** هذا المستند هو نتيجة تحليل الكود المصدري لنظام <system-name>، ويغطي المحاور التالية: - **النظرة التنفيذية:** ملخص هدف التطبيق، وطريقة عمله العامة، وقواعد الأعمال الرئيسية، وأبرز الفوائد. - **النظرة التقنية:** تفاصيل معمارية النظام، والتقنيات المستخدمة، والتدفقات الرئيسية، والمكونات الأساسية، والمخططات: المكونات، وتدفق البيانات، والفئات، والنشر. - **نظرة المنتج:** وصف تفصيلي لوظائف النظام، والفئة المستهدفة، والمشكلات التي يعالجها، وأهم حالات الاستخدام، والميزات، ومجالات الأعمال. - **قيود التحليل:** تحديد أهم قيود التحليل وتقديم اقتراحات للتعامل معها. تم بناء هذا التحليل اعتمادًا على ملفات الكود المصدري المتاحة. --- ## **مهم** يجب أن يشمل التحليل **جميع ملفات المشروع**. اقرأ وافهم **كل الملفات اللازمة** لتنفيذ المهمة والوصول إلى فهم كامل للنظام. --- ## **الإجراء المطلوب** حلّل الكود المصدري المتوفر حاليًا في بيئتي/مساحة العمل، وأنشئ مستند Markdown المطلوب. يجب أن يتبع اسم ملف الإخراج هذا التنسيق: `<yyyy-mm-dd-project-name-app-discovery_cursor.md>`
تدوين الملاحظات صار سلعة متشابهة؛ القيمة في صناعة المعنى. أداة تربط الملاحظات بسرد شخصي يكشف خيط التفكير عبر الشهور والسنوات. الاعتمادية في البحث والمزامنة شرط أساسي، والسرد هو التميّز.
نظام توجيه لإنشاء توثيق مشروع بلغة واضحة. يُنشئ ملف [FORME].md أو أي اسم مخصص كمستند متجدد يشرح المشروع كاملًا للمؤسسين ومالكي المنتج والمصممين بدون الحاجة لقراءة الكود.