C✳CODEZ.WIN
🌐 العربية

دليل قراءة متعدد اللغات للمهارة

documentationالغرض والاستخدام والمصدر

كتابة وصيانة الوثائق التقنية. يتم تفعيل هذه الميزة عند استخدام عبارات مثل "كتابة وثائق لـ"، "توثيق هذا"، "إنشاء ملف README"، "كتابة دليل تشغيل"، "دليل الإعداد"، أو عندما يحتاج المستخدم إلى مساعدة في أي نوع من أنواع الكتابة التقنية - وثائق واجهة برمجة التطبيقات، أو وثائق البنية، أو أدلة التشغيل.

تم استرجاع المصدر:

مستودع المصدر
anthropics/knowledge-work-plugins
SKILL.md
engineering/skills/documentation/SKILL.md
نجوم المستودع
34,049
آخر تحديث للمستودع
2026-10-30
تصنيف القدرات
المستندات
وقت التجميع الأخير

الترخيص: Apache-2.0

مقتطفات سير العمل هي أدوات مساعدة للقراءة، وليست تعليمات تنفيذية من Codez. لم يتم تشغيل أي مهارة تابعة لجهة خارجية لإنتاج هذه الصفحة.

تُعدّ فقرات الغرض وسير العمل الواردة أدناه موادًا أساسية، مُنظّمة ومترجمة لتسهيل القراءة. وهي تختلف عن التحليل التحريري لـ Codez المُصنّف بشكل منفصل.

ما تفعله هذه المهارة

كتابة وصيانة الوثائق التقنية. يتم تفعيل هذه الميزة عند استخدام عبارات مثل "كتابة وثائق لـ"، "توثيق هذا"، "إنشاء ملف README"، "كتابة دليل تشغيل"، "دليل الإعداد"، أو عندما يحتاج المستخدم إلى مساعدة في أي نوع من أنواع الكتابة التقنية - وثائق واجهة برمجة التطبيقات، أو وثائق البنية، أو أدلة التشغيل.

طريقة الاستخدام وفق المستند الأصلي

الوثائق الفنية

كتابة وثائق تقنية واضحة وقابلة للصيانة لمختلف الجماهير والأغراض.

مقتطف من المصدر · L6 ↗

ملف التعليمات

ما هو هذا ولماذا هو موجود؟ دليل البدء السريع (<5دقائق لتحقيق النجاح الأول)

مقتطف من المصدر · L12 ↗

وثائق واجهة برمجة التطبيقات

مرجع نقطة النهاية معrequest/responseأمثلة على رموز المصادقة والخطأ

مقتطف من المصدر · L18 ↗

المتطلبات والإعداد

لم يتم اختيار أي فقرة متطلبات مختصرة من هذا الملف. هذا لا يعني أن المهارة لا تعتمد على أي ملفات أخرى. راجع تعليمات إعداد المستودع والملفات المرجعية.

الحدود وفحوصات الجودة

لم يتم تحديد أي مقطع حدود منفصل من هذا الملف. هذا لا يعني أن المهارة آمنة لكل مدخلات أو بيئة. راجع المصدر بالكامل وتحقق من صحة النتيجة بنفسك.

ابدأ بتجربة آمنة

  1. تحقق من المضيف المدعوم وتعليمات تثبيت المستودع. احتفظ بمجلد المهارات والبرامج النصية والأصول والوثائق المشار إليها معًا؛SKILL.mdقد يؤدي وجود شخص واحد فقط إلى إغفال بعض التبعيات.
  2. زوّد البرنامج ببياناتك الفعلية، والمخرجات المطلوبة، ومعايير القبول. يعتمد بناء جملة الاستدعاء والأدوات المتاحة على النظام المضيف؛ ولا يفترض هذا الموقع وجود أمر تثبيت موحد.
  3. جرّب سير العمل الأصلي في مشروع مؤقت أو على نسخة احتياطية. راجع العمليات التي تُغيّر الملفات أو الخدمات البعيدة أو الموارد القابلة للفوترة قبل السماح بها.
  4. تحقق من صحة المخرجات بمقارنتها بفحوصات جودة المصدر ومتطلباتك الخاصة. لا يُعدّ نجاح عملية التشغيل أو ارتفاع عدد النجوم في المستودع دليلاً على صحة النتيجة.

مواصفات ملف المهارة وبنية المجلدات ↗

اقرأ المزيد في المصدر

الترجمة والنطاق

يختار دليل القراءة هذا مقاطع من المصدر الرئيسي المثبتSKILL.mdهذه الترجمة مساعدة. وهي ليست دليلاً كاملاً ولا تضمن التوافق المُختَبَر. يُرجى قراءة النص الأصلي والملفات المُشار إليها قبل الاستخدام.

تشير هذه المقدمة إلى النسخة المثبتة أدناه؛ ويتم عرض نشاط المستودع الحالي ووقت التجميع بشكل منفصل.

المصدر بإصدار ثابت
اقرأ الأصل ↗
تم استرجاع المصدر
معرّف نسخة Git
2574e29377c7173d0cecffef29a6ecbd7f8ccb5d
المصدر SHA-256
1d469418f786a05be83d2a05f04d68788aeed584d13863a650f5ad73c6c4cf50
العودة إلى قائمة المهارات الكاملة