documentation-templates
إنشاء توثيق متسق للمشاريع
تخسر الفرق وقتا عندما تفتقر وثائق المشروع إلى البنية. توفر هذه المهارة قوالب جاهزة لملفات README، وتوثيق API، وسجلات التغييرات، وADRs، والوثائق الملائمة للذكاء الاصطناعي.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "documentation-templates" from https://skillstore.io/skills/sickn33-documentation-templates.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-templates/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "documentation-templates". يطلب مشرف صيانة إرشادات README لمكتبة جديدة.
النتيجة المتوقعة:
- مخطط README يتضمن العنوان، والغرض، والبداية السريعة، والميزات، والتهيئة، وروابط التوثيق، والترخيص.
- عناصر نائبة مختصرة لكل قسم حتى يتمكن مشرف الصيانة من ملء تفاصيل المشروع.
جارٍ استخدام "documentation-templates". يحتاج فريق إلى تسجيل قرار متعلق بالتخزين.
النتيجة المتوقعة:
مسودة ADR تتضمن الحالة، والسياق، والقرار، والعواقب، والمفاضلات بلغة واضحة.
جارٍ استخدام "documentation-templates". يحتاج فريق منتج إلى توثيق endpoint.
النتيجة المتوقعة:
مخطط مستند endpoint يتضمن المسار، والغرض، وجدول المعاملات، وحالات الاستجابة، وملاحظات طلب مثال.
التدقيق الأمني
آمنAll 15 static findings are false positives caused by fenced documentation examples and ordinary template wording. The skill contains no executable commands, system reconnaissance, prompt injection, or other semantic security concerns.
عوامل الخطر
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/sickn33-documentation-templates/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/sickn33-documentation-templates?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/sickn33-documentation-templates?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-templates/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-templates.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-templates security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-templates/audits/5اقتباس BibTeX
@techreport{sickn33-sickn33-documentation-templates-2026,
author = {sickn33},
title = {documentation-templates security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-documentation-templates/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-templates 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-templates/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-documentation-templates:audit:5"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: مرتفعما الذي يمكنك بناؤه
توحيد وثائق الهندسة
إنشاء خط أساس مشترك للتوثيق للخدمات أو المكتبات أو الأدوات الداخلية الجديدة.
إعداد مراجع API
تنظيم توثيق endpoints قبل تسليمه إلى المطورين أو الكتاب أو فرق دعم العملاء.
تحسين مشاريع المصدر المفتوح
إضافة أقسام README، وسجل تغييرات، وADR، وتوثيق موجه للذكاء الاصطناعي يمكن للمساهمين توقعها.
جرّب هذه الموجّهات
استخدم مهارة documentation-templates لصياغة README لهذا المشروع: [project summary]. أدرج البداية السريعة، والميزات، والتهيئة، والتوثيق، والترخيص.
استخدم قالب توثيق API لهذا endpoint: [method and path]. أدرج الغرض، والمعاملات، والاستجابات، ووصفا لمثال.
استخدم قالب ADR لتوثيق هذا القرار: [decision]. أدرج الحالة، والسياق، والقرار، والعواقب.
أنشئ خطة توثيق لـ [project]. أدرج بنية README، وإرشادات تعليقات الكود، وأقسام سجل التغييرات، وADRs، وllms.txt، والأقسام الجاهزة لـ RAG.
أفضل الممارسات
- ابدأ بأصغر مستند مفيد، ثم أضف التفاصيل عندما يطرح القراء أسئلة متكررة.
- استبدل العناصر النائبة بأسماء وأوامر وendpoints وقيود خاصة بالمشروع قبل النشر.
- حافظ على مزامنة سجلات التغييرات وADRs والملفات الموجهة للذكاء الاصطناعي مع التغييرات الرئيسية في المنتج.
تجنب
- نشر القوالب مع عناصر نائبة غير معدلة.
- إضافة تعليقات تكرر سلوك الكود الواضح.
- التعامل مع ADR على أنه نهائي بينما لا يزال القرار غير محسوم.
الأسئلة المتكررة
هل تنشئ هذه المهارة توثيقا كاملا تلقائيا؟
هل يمكنها كتابة صفحات مرجعية لـ API؟
هل تدعم التوثيق الملائم للذكاء الاصطناعي؟
هل تقتصر على مشاريع البرمجيات؟
هل تشغل أوامر أو تفحص مستودعي؟
هل يمكنني استخدامها مع Claude Code وCodex؟
تفاصيل المطور
المؤلف
sickn33الترخيص
MIT
مراجعة Skillstore
r2
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
المستودع
https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templatesمرجع
f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526
حداثة الصيانة
٢٦/٧/٢٠٢٦
الاستخدام
9 تنزيلات · 90 مشاهدات
بنية الملفات
📄 SKILL.md