documentation-generation-doc-generate
إنشاء توثيق شامل من الكود
حافظ على مزامنة التوثيق مع الكود تلقائياً. تستخرج هذه المهارة المعلومات من الكود المصدري لإنشاء مواصفات API ومخططات البنية وأدلة المستخدم التي تظل محدثة مع تطور قاعدة الكود الخاصة بك.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "documentation-generation-doc-generate". Analyze Python API routes in src/routes/
النتيجة المتوقعة:
- OpenAPI 3.0 specification file (openapi.yaml)
- Interactive API documentation HTML page
- Code examples in Python, JavaScript, and cURL for each endpoint
استخدام "documentation-generation-doc-generate". Document the microservices architecture
النتيجة المتوقعة:
- System architecture diagram showing service relationships
- Component documentation with technology stacks and responsibilities
- Data flow diagrams for key business processes
التدقيق الأمني
آمنThis skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
درجة الجودة
ماذا يمكنك بناءه
توليد توثيق API
إنشاء مواصفات OpenAPI وتوثيق API التفاعلي تلقائياً من تعريفات المسارات وتعليقات قاعدة الكود الخاصة بك.
توثيق البنية
إنشاء مخططات بنية النظام وتوثيق المكونات من خلال تحليل الواردات والتبعيات وهيكل الكود.
أتمتة خط أنابيب التوثيق
إعداد سير عمل CI/CD الذي يعيد توليد ونشر التوثيق في كل عملية إرسال للكود للحفاظ على مزامنة التوثيق.
جرّب هذه الموجهات
Analyze the Python files in ./src/api/ directory and generate OpenAPI 3.0 specification with all endpoints, request/response schemas, and authentication requirements.
Create a comprehensive README.md for this repository including installation instructions, configuration options, usage examples, and contribution guidelines based on the code structure.
Examine the service modules and their imports to create Mermaid diagrams showing system architecture, data flow, and component dependencies.
Generate complete documentation including API reference, architecture overview, getting started guide, and deployment instructions. Set up a documentation site using the generated artifacts with search functionality.
أفضل الممارسات
- قم بتشغيل توليد التوثيق كجزء من CI/CD للحفاظ على مزامنة التوثيق مع تغييرات الكود
- قم بتضمين فحوصات تغطية التوثيق التي تفشل في البناء عندما تنخفض التغطية عن الحد المحدد
- راجع التوثيق المنشأ للتأكد من دقته وأضف السياق البشري حيثما يلزم
تجنب
- توليد التوثيق مرة واحدة وعدم تحديثه مع تطور الكود
- نشر التوثيق المنشأ دون مراجعة بشرية للتأكد من دقته
- تضمين معلومات حساسة مثل مفاتيح API أو عناوين URL الداخلية في التوثيق المنشأ