documentation-generation-doc-generate
إنشاء توثيق برمجي قابل للصيانة
غالبًا ما يتأخر التوثيق اليدوي عن الكود النشط. تساعد هذه المهارة Claude وCodex وClaude Code على إنشاء توثيق واضح وخطط أتمتة.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "documentation-generation-doc-generate" from https://skillstore.io/skills/sickn33-documentation-generation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-generation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "documentation-generation-doc-generate". تحتاج خدمة Backend إلى توثيق قبل إطلاق API.
النتيجة المتوقعة:
- مخطط مرجع API يتضمن مجموعات نقاط النهاية، وملاحظات المصادقة، وأقسام الأخطاء.
- أسئلة مفتوحة حول الإصدارات، وحدود المعدل، ونماذج الاستجابات.
- خطوات تحقق موصى بها قبل النشر.
جارٍ استخدام "documentation-generation-doc-generate". يريد فريق توثيق البنية لنظام microservice.
النتيجة المتوقعة:
- نظرة عامة على النظام تتضمن مسؤوليات الخدمات وتدفقات البيانات.
- خطة مخطط باستخدام صياغة Mermaid كتنسيق مستهدف.
- المخاطر والافتراضات التي تحتاج إلى مراجعة المالك.
جارٍ استخدام "documentation-generation-doc-generate". يحتوي مستودع على ملاحظات إعداد متفرقة ولا يحتوي على دليل مساهمين.
النتيجة المتوقعة:
- بنية README تتضمن أقسام الإعداد، والتهيئة، والاختبار، والمساهمة.
- قائمة بالحقائق الناقصة التي يجب التحقق منها مع المشرفين.
- قائمة تحقق للأتمتة للحفاظ على تحديث التوثيق.
التدقيق الأمني
آمنAll 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.
عوامل الخطر
⚙️ الأوامر الخارجية (9)
🌐 الوصول إلى الشبكة (8)
📁 الوصول إلى نظام الملفات (1)
🔑 متغيرات البيئة (7)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-generation-doc-generate.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
sickn33. (2026). documentation-generation-doc-generate security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5اقتباس BibTeX
@techreport{sickn33-sickn33-documentation-generation-doc-generate-2026,
author = {sickn33},
title = {documentation-generation-doc-generate security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5},
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: "documentation-generation-doc-generate security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-documentation-generation-doc-generate:audit:5"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: مرتفعما الذي يمكنك بناؤه
توثيق إصدار API
إنشاء مراجع لنقاط النهاية، وملاحظات المصادقة، وأوصاف الاستجابات، وتوثيق API تفاعلي من تعريفات المسارات الحالية.
شرح بنية النظام
تحويل الخدمات ومخازن البيانات وتفاصيل النشر إلى مخططات وتوثيق موجز للمكونات.
توحيد توثيق المشروع
إنشاء أقسام README والإعداد ودليل المستخدم والمساهمة واستكشاف الأخطاء وإصلاحها ببنية متسقة.
جرّب هذه الموجّهات
راجع هذا المستودع واقترح خطة توثيق. تضمّن الجماهير المستهدفة، والمستندات المطلوبة، وملفات المصدر التي يجب فحصها، والأسئلة المفتوحة.
حلّل تعريفات المسارات وصِغ توثيق API. تضمّن نقاط النهاية، والمعاملات، والمصادقة، والأخطاء، والأمثلة، وفجوات التحقق.
أنشئ توثيقًا لبنية هذا التطبيق. تضمّن المكونات، وتدفقات البيانات، والاعتماديات، والمخططات، والاعتبارات التشغيلية، والافتراضات.
صمّم سير عمل لأتمتة التوثيق. تضمّن خطوات الإنشاء، والفحص، وفحوصات التغطية، وبوابات المراجعة، والنشر، ومخاطر الصيانة.
أفضل الممارسات
- راجع التوثيق المُنشأ مقابل الكود المصدري قبل النشر.
- استبدل جميع العناصر النائبة بقيم خاصة بالمشروع.
- احجب الأسرار، وعناوين URL الداخلية، وتفاصيل التنفيذ الحساسة.
تجنب
- نشر التوثيق المُنشأ دون مراجعة المشرف.
- نسخ أوامر العناصر النائبة أو الرموز إلى توثيق الإنتاج.
- توثيق تفاصيل البنية التحتية الخاصة في مستودعات عامة.
الأسئلة المتكررة
ما أنواع التوثيق التي يمكن لهذه المهارة إنشاؤها؟
هل تعدّل الكود الخاص بي تلقائيًا؟
هل يمكنها إنشاء توثيق OpenAPI؟
هل يمكنها إنشاء مخططات؟
هل ينبغي أن أنشر التوثيق المُنشأ فورًا؟
هل تعمل مع Claude وCodex وClaude Code؟
تفاصيل المطور
المؤلف
sickn33الترخيص
MIT
مراجعة Skillstore
r2
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
مرجع
f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526
حداثة الصيانة
٢٦/٧/٢٠٢٦
الاستخدام
10 تنزيلات · 108 مشاهدات
بنية الملفات