crafting-effective-readmes
إنشاء ملفات README تركّز على الجمهور
غالبًا ما تفوّت ملفات README العامة احتياجات المساهمين أو زملاء الفريق أو القائمين على الصيانة مستقبلًا. ترشد هذه المهارة Claude وCodex وClaude Code من خلال أسئلة حول الجمهور وقوالب وفحوصات جودة.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "crafting-effective-readmes" from https://skillstore.io/skills/softaworks-crafting-effective-readmes.md and its manifest at https://skillstore.io/api/skills/softaworks-crafting-effective-readmes/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "crafting-effective-readmes". يطلب المستخدم README لأداة CLI جديدة مفتوحة المصدر.
النتيجة المتوقعة:
- أسئلة حول الجمهور ومسار التثبيت والأمر الأساسي والترخيص وسياسة المساهمة.
- مخطط README يتضمن أقسام العنوان والوصف والتثبيت والاستخدام والمساهمة والترخيص.
- مطالبة متابعة تسأل عمّا يجب إبرازه أيضًا.
جارٍ استخدام "crafting-effective-readmes". يطلب المستخدم تحديث README لخدمة داخلية.
النتيجة المتوقعة:
- مراجعة للأقسام القديمة بناءً على README الحالي وملفات المشروع.
- تحديثات مقترحة للإعداد المحلي وملاحظات البنية والملكية وrunbooks واستكشاف الأخطاء وإصلاحها.
- ملاحظات واضحة حول التفاصيل الخاصة بالفريق التي ما زالت مطلوبة.
جارٍ استخدام "crafting-effective-readmes". يسأل المستخدم ما إذا كان README لمشروع شخصي جاهزًا للملف المهني.
النتيجة المتوقعة:
- مراجعة للجمهور وغرض المشروع ولقطات الشاشة وأمثلة الاستخدام وملاحظات التعلم.
- تعديلات محددة تجعل المشروع أسهل في التصفح والفهم.
- قائمة تحقق نهائية موجزة للنشر.
التدقيق الأمني
آمنAll 20 static findings were reviewed in context and judged false positives. The flagged items are markdown guidance, example paths, environment variable placeholders, and reference links. I found no active code execution, secret collection, file traversal, or prompt injection.
عوامل الخطر
📁 الوصول إلى نظام الملفات (1)
⚙️ الأوامر الخارجية (7)
🔑 متغيرات البيئة (2)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/softaworks-crafting-effective-readmes/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/softaworks-crafting-effective-readmes?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/softaworks-crafting-effective-readmes?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/softaworks-crafting-effective-readmes/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/softaworks-crafting-effective-readmes.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
softaworks. (2026). crafting-effective-readmes security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/softaworks-crafting-effective-readmes/audits/5اقتباس BibTeX
@techreport{softaworks-softaworks-crafting-effective-readmes-2026,
author = {softaworks},
title = {crafting-effective-readmes security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/softaworks-crafting-effective-readmes/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: "crafting-effective-readmes security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "softaworks"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/softaworks-crafting-effective-readmes/audits/5"
identifiers:
- type: other
value: "skillstore:softaworks-crafting-effective-readmes:audit:5"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: مرتفعما الذي يمكنك بناؤه
إطلاق مشروع مفتوح المصدر
ينشئ القائم على الصيانة README يتضمن أقسام التثبيت والاستخدام والمساهمة والترخيص للمساهمين الجدد.
توثيق خدمة داخلية
ينشئ قائد الفريق ملاحظات تهيئة للانضمام، وخطوات إعداد محلية، وسياقًا معماريًا، وأقسام runbook لزملاء الفريق.
تحديث README لمشروع شخصي
يحدث مطور نصًا قديمًا، ويضيف أمثلة، ويشرح ما تعلمه لقراء ملفه المهني.
جرّب هذه الموجّهات
أنشئ README لهذا المشروع. اسألني عن نوع المشروع، ومن سيقرأه، وأسرع مسار ناجح لاستخدامه.
راجع README الحالي وساعدني في إضافة قسم للتثبيت أو الاستخدام أو المساهمة أو أي فجوة أخرى تجدها.
لقد غيّرت هذا المشروع وأحتاج إلى تحديث README. قارن README بملفات المشروع واقترح تعديلات واضحة.
دقق هذا README من حيث ملاءمته لجمهوره المستهدف. تحقق من ترتيب الأقسام والسياق المفقود والادعاءات القديمة والأمثلة والنبرة وملاءمته لنوع المشروع.
أفضل الممارسات
- ابدأ بتسمية القراء المستهدفين وأول مهمة ناجحة لهم.
- استخدم أصغر مجموعة أقسام تجيب عن أسئلة المشروع الفعلية.
- حافظ على الإعداد والاستخدام والأمثلة محدثة بما يتوافق مع حالة المشروع التي تم فحصها.
تجنب
- استخدام قالب مفتوح المصدر لكل مشروع دون التحقق من الجمهور.
- كتابة ادعاءات واسعة حول الميزات دون أمثلة أو خطوات إعداد.
- ترك أوامر أو روابط أو تفاصيل ملكية قديمة بعد تغييرات المشروع.
الأسئلة المتكررة
ما أنواع ملفات README التي تدعمها هذه المهارة؟
هل يمكنها تحديث README موجود؟
هل تفحص ملفات المشروع تلقائيًا؟
هل هي مخصصة فقط للمشاريع مفتوحة المصدر؟
هل تكتب توثيق API كاملًا؟
كيف تتجنب نص README العام؟
تفاصيل المطور
المؤلف
softaworksالترخيص
MIT
مراجعة Skillstore
r1
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
مرجع
3e4b6c31a74a3bd1a291c98cf585d720cb9fbc88
حداثة الصيانة
١٨/٧/٢٠٢٦
الاستخدام
18 تنزيلات · 151 مشاهدات
بنية الملفات