المهارات doc-generator
📦

doc-generator

مراجعة المحتوى r2 آمن ⚙️ الأوامر الخارجية

إنشاء توثيق Python

غالبا ما تفتقر مشاريع Python إلى توثيق API محدث. تساعد هذه المهارة Claude أو Codex أو Claude Code على إنشاء مستندات Markdown من بنية المصدر وdocstrings وتلميحات الأنواع.

يدعم: Claude Codex Code(CC)
🥉 78 برونزي

التثبيت باستخدام Agent لدي

انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.

طلب الوكيل
Review the Skillstore skill "doc-generator" from https://skillstore.io/skills/bossjones-doc-generator.md and its manifest at https://skillstore.io/api/skills/bossjones-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.

موارد مهيّأة لـ Agents

استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.

تفاصيل Markdown GET /skills/bossjones-doc-generator.md manifest موقَّع GET /api/skills/bossjones-doc-generator/manifest lockfile موقَّع GET /api/skills/bossjones-doc-generator/lockfile

اختبرها

جارٍ استخدام "doc-generator". يوجه المستخدم المهارة إلى وحدة Python تحتوي على فئات وطرق وdocstrings عامة.

النتيجة المتوقعة:

مرجع API بصيغة Markdown يتضمن ملخص الوحدة وأقسام الفئات وتواقيع الطرق وملاحظات المعاملات وأوصاف الإرجاع وملاحظات الاستخدام.

جارٍ استخدام "doc-generator". يطلب المستخدم محتوى README من حزمة Python صغيرة.

النتيجة المتوقعة:

قسم جاهز لـ README يتضمن نظرة عامة على الحزمة وملخص API العام وإرشادات الاستخدام الشائعة وتحذيرات بشأن الأوصاف المفقودة.

جارٍ استخدام "doc-generator". يطلب المستخدم تغطية التوثيق لفرع إصدار.

النتيجة المتوقعة:

تقرير توثيق يسرد الأقسام المنشأة وdocstrings المفقودة وتفاصيل المعاملات غير المكتملة والإصلاحات المقترحة.

التدقيق الأمني

آمن
v9 • ٢٣‏/٧‏/٢٠٢٦ فتح التقرير المرتبط بالإصدار

All eight static findings are false positives caused by Markdown fences or inline code formatting in SKILL.md. The skill contains no shell commands, prompt injection, network instructions, or semantic evidence of malicious intent.

1
الملفات التي تم فحصها
97
الأسطر التي تم تحليلها
0
عناصر المراجعة
0
تم تجاهل الإيجابيات الكاذبة

عوامل الخطر

⚙️ الأوامر الخارجية (8)
SKILL.md:29-41 SKILL.md:41-50 SKILL.md:50-57 SKILL.md:57-59 SKILL.md:59-60 SKILL.md:60-85 SKILL.md:85-86 SKILL.md:86-87
لم يكتشف أحدث تدقيق ثابت ودلالي مكتمل أي نتائج أمنية مؤكدة. ولا يثبت ذلك أن المهارة خالية من الآثار الجانبية.
دقّقه: codex عرض سجل التدقيق →
شارك واستشهد بهذا التقرير

شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.

فتح التقرير المرتبط بالإصدار
تقييم الأمان

نسخ رابط التقرير

https://skillstore.io/skills/bossjones-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

شارة Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/bossjones-doc-generator/security.svg)](https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge)

شارة HTML

<a href="https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/bossjones-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

بطاقة قابلة للتضمين

<iframe src="https://skillstore.io/embed/skills/bossjones-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
الاستشهادات الأكاديمية (APA · BibTeX · CFF)

اقتباس APA

bossjones. (2026). doc-generator security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/bossjones-doc-generator/audits/9

اقتباس BibTeX

@techreport{bossjones-bossjones-doc-generator-2026, author = {bossjones}, title = {doc-generator security audit report (audit version 9)}, institution = {Skillstore}, year = {2026}, number = {9}, url = {https://skillstore.io/skills/bossjones-doc-generator/audits/9}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "doc-generator security audit report (audit version 9)" version: "unspecified" type: report authors: - name: "bossjones" date-released: "2026-07-23" url: "https://skillstore.io/skills/bossjones-doc-generator/audits/9" identifiers: - type: other value: "skillstore:bossjones-doc-generator:audit:9" description: "Skillstore immutable audit report identifier"

تقييم Skillstore

سبب هذا التقييم موثوقية الأدلة: مرتفع
55
الهندسة المعمارية
85
قابلية الصيانة
87
المحتوى
70
المجتمع
83
الامتثال للمواصفات

ما الذي يمكنك بناؤه

توثيق حزمة Python

إنشاء مرجع API منظم بصيغة Markdown من وحدات الحزمة وفئاتها وطرقها ودوالها.

تحديث README لمشروع

إنشاء أقسام README تلخص واجهات API العامة وأمثلة الاستخدام وتواقيع الأنواع المتاحة.

إعداد ملاحظات API داخلية

تحويل وحدات الخدمات أو الأدوات المساعدة إلى توثيق قابل للقراءة للتسليم أو التهيئة أو المراجعة.

جرّب هذه الموجّهات

توثيق ملف واحد 
أنشئ توثيقا بصيغة Markdown لهذا الملف Python. ضمّن ملخص الوحدة والفئات العامة والدوال العامة والمعاملات وقيم الإرجاع وتحذيرات واضحة بشأن docstrings المفقودة.
إنشاء مستندات API للحزمة 
أنشئ توثيق API لهذه الحزمة Python. عالج الوحدات العامة، واجمع المخرجات حسب الوحدة، وضمّن تواقيع الفئات والدوال، وأضف جدول محتويات.
تحسين المستندات الحالية 
حدّث توثيق Markdown الحالي باستخدام مصدر Python الحالي. حافظ على البنية الحالية حيثما أمكن، وحدّث التواقيع القديمة، واذكر الأعضاء العامين غير الموثقين.
تدقيق تغطية التوثيق 
راجع قاعدة كود Python هذه من حيث تغطية التوثيق. أنشئ مستندات API بصيغة Markdown، وحدد docstrings المفقودة أو الضعيفة، وأوصِ بإصلاحات التوثيق ذات الأولوية الأعلى.

أفضل الممارسات

  • شغّله على ملفات مصدر نظيفة تحتوي على docstrings وتلميحات أنواع محدثة.
  • فضّل التحليل المستند إلى AST للمستودعات غير الموثوقة.
  • راجع الأمثلة المنشأة قبل نشرها للمستخدمين.

تجنب

  • لا تعتمد على المستندات المنشأة كبديل عن تعليقات المصدر الدقيقة.
  • لا تستخدم الفحص وقت التشغيل على Python غير موثوق بدون عزل.
  • لا تنشر مستندات API المنشأة دون التحقق من الأعضاء العامين مقابل الأعضاء الخاصين.

الأسئلة المتكررة

ما اللغات التي تدعمها هذه المهارة؟
تم تصميمها لقواعد كود Python ومخرجات توثيق Markdown.
هل يمكنها إنشاء ملفات README؟
نعم. يمكنها إنشاء أقسام README من بنية المصدر وdocstrings وتلميحات الأنواع وأمثلة الاستخدام.
هل تتطلب تبعيات خارجية؟
توصي المهارة بأدوات Python القياسية مثل ast وinspect وpathlib لإنشاء التوثيق الأساسي.
كيف تتعامل مع docstrings المفقودة؟
تواصل المعالجة وتضع علامة على الأوصاف المفقودة بدلا من إفشال مهمة التوثيق بالكامل.
هل الفحص وقت التشغيل آمن؟
يمكن للفحص وقت التشغيل تنفيذ كود Python الهدف عبر imports. استخدم تحليل AST أو فحص وقت التشغيل داخل sandbox للمشاريع غير الموثوقة.
ما أدوات AI التي يمكنها استخدام هذه المهارة؟
يسرد التقرير دعما لـ Claude وCodex وClaude Code.

تفاصيل المطور

المؤلف

bossjones

الترخيص

MIT

مراجعة Skillstore

r2

تنبيه الإصدار

لم يعلن المؤلف عن إصدار.

المستودع

https://github.com/bossjones/logging-lab/tree/main/.claude/skills/doc-generator

مرجع

a39a91716eadede5f4cdefd78178fed4e837a128

حداثة الصيانة

٢٥‏/٧‏/٢٠٢٦

الاستخدام

9 تنزيلات · 173 مشاهدات

بنية الملفات

📄 SKILL.md

المزيد من bossjones

عرض الكل

مهارات ذات صلة

عرض الكل