Docs Architect
إنشاء وثائق تقنية من الكود
يكافح المطورون للحفاظ على وثائق شاملة مع تطور قواعد الكود. مهارة Docs Architect تقوم بتحليل الكود تلقائياً وتنتج أدلة تقنية مفصلة تغطي البنية وأنماط التصميم وتفاصيل التنفيذ.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "Docs Architect". توثيق نظام المصادقة في قاعدة الكود هذه
النتيجة المتوقعة:
قسم شامل يغطي تدفقات مصادقة المستخدمين، وإدارة الرموز، والتعامل مع الجلسات، واعتبارات الأمان، وأمثلة الكود التي توضح تفاصيل التنفيذ الرئيسية
استخدام "Docs Architect". إنشاء نظرة عامة على البنية لتطبيق الخدمات المصغرة هذا
النتيجة المتوقعة:
ملخص تنفيذي، مخطط تبعيات الخدمات، أنماط الاتصال، استراتيجية تخزين البيانات، طبولوجيا النشر، والأساس المنطقي للتصميم لكل قرار رئيسي
استخدام "Docs Architect". كتابة وثائق API لوحدة معالجة المدفوعات
النتيجة المتوقعة:
مرجع API كامل مع تعريفات النقاط النهائية، ومخططات الطلب/الاستجابة، ومتطلبات المصادقة، ورموز الأخطاء، وحدود المعدل، وأمثلة الاستخدام
التدقيق الأمني
آمنPrompt-only documentation skill with no executable code. Static analysis found zero suspicious patterns and no risk factors. This is a pure prompt template skill that guides AI to generate documentation from analyzed codebases.
درجة الجودة
ماذا يمكنك بناءه
إدماج المطورين الجدد
إنشاء وثائق شاملة لمساعدة أعضاء الفريق الجدد على فهم بنية النظام والتبعيات واتفاقيات الترميز
توثيق الكود القديم
توثيق الأنظمة الحالية بدون وثائق للحفاظ على المعرفة والمساعدة في الصيانة المستقبلية
سجلات قرارات البنية
إنشاء سجلات قرارات بنية تفصيلية تشرح خيارات التصميم والمقايضات وتطور بنية النظام
جرّب هذه الموجهات
تحليل وتوثيق ملف الكود التالي. اشرح ما يفعله كل قسم رئيسي، وهياكل البيانات المستخدمة، وأي أنماط مهمة:
تقديم نظرة شاملة على بنية قاعدة الكود. يتضمن: ملخص تنفيذي، المكونات الرئيسية، تدفق البيانات، وقرارات التصميم الرئيسية.
إنشاء مرجع API كامل لقاعدة الكود هذه. توثيق جميع النقاط النهائية، وتنسيقات الطلب/الاستجابة، ومتطلبات المصادقة، ورموز الأخطاء.
إنشاء دليل تقني شامل يغطي: نظرة عامة على البنية، قرارات التصميم، المكونات الأساسية، نماذج البيانات، نقاط التكامل، النشر، الأمان، واستكشاف الأخطاء. يتضمن أمثلة كود طوال الدليل.
أفضل الممارسات
- البدء بالمستوى العالي من البنية قبل الغوص في تفاصيل التنفيذ لمنح القراء السياق
- تضمين أمثلة الكود من قاعدة الكود الفعلية لتوضيح المفاهيم بسياق واقعي
- توثيق الحالة الحالية والمنطق وراء قرارات التصميم لمساعدة القراء على فهم التطور
تجنب
- إنشاء الوثائق بدون فهم أولاً بنية قاعدة الكود والتبعيات
- نسخ ولصق تعليقات الكود بدون إضافة سياق أو شرح أو سرد قصصي
- التركيز فقط على تفاصيل التنفيذ بدون شرح الأساس المنطقي أو المقايضات المتخذة