skill

التوثيق

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

Anthropic4.80+ تثبيتموثوق

نبذة

# التوثيق التقني

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

## أنواع المستندات

### ملف README - ما هذا ولماذا يوجد - البدء السريع (أقل من 5 دقائق للنجاح الأول) - الإعدادات والاستخدام - دليل المساهمة

### توثيق API - مرجع نقاط النهاية مع أمثلة الطلب والاستجابة - المصادقة وأكواد الأخطاء - حدود المعدل والترقيم - أمثلة SDK

### دليل التشغيل - متى يتم استخدام هذا الدليل - المتطلبات الأساسية والوصول المطلوب - الإجراء خطوة بخطوة - خطوات التراجع - مسار التصعيد

### مستند العمارة - السياق والأهداف - التصميم عالي المستوى مع المخططات - القرارات الرئيسية والمقارنات - تدفق البيانات ونقاط التكامل

### دليل الإعداد الأولي - إعداد البيئة - الأنظمة الرئيسية وكيفية توصيلها - المهام الشائعة مع شروحات عملية - من تسأل عن ماذا

## المبادئ

1. **اكتب للقارئ** — من يقرأ هذا وماذا يحتاج؟ 2. **ابدأ بالمعلومات الأكثر فائدة** — لا تخف المعلومات الأساسية 3. **أظهر، لا تخبر** — أمثلة أكواد وأوامر وصور توضيحية 4. **أبقها محدثة** — التوثيق القديم أسوأ من عدم وجود توثيق 5. **ربط، لا تكرر** — أشر إلى مستندات أخرى بدلا من نسخ المحتوى

التثبيت

شغل هذا الأمر

git clone https://github.com/anthropics/knowledge-work-plugins && cp -r knowledge-work-plugins/engineering/skills/documentation ~/.claude/skills/

يعمل مع

claude appclaude codeclaude apicursorcodexwindsurfclinezed

خطوات التثبيت

استنسخ المستودع وانسخ مجلد `engineering/skills/documentation` إلى دليل مهارات Claude الخاص بك. متوافق مع Claude Code و Cursor و Codex وأي وكيل متوافق مع Agent Skills.

عرض المصدر
الرخصة: Apache-2.0بواسطة Anthropic

أسئلة شائعة

ما هي مهارة التوثيق؟

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

كيف أثبت التوثيق؟

شغل هذا الأمر في الطرفية:

git clone https://github.com/anthropics/knowledge-work-plugins && cp -r knowledge-work-plugins/engineering/skills/documentation ~/.claude/skills/
مع أي أدوات ذكاء اصطناعي تعمل التوثيق؟

تعمل مع claude_app، claude_code، claude_api، cursor، codex، windsurf، cline، zed.

من طور التوثيق؟

طورها Anthropic، وتصدر بترخيص Apache-2.0.

هل التوثيق مجانية؟

نعم، يمكنك استخدامها مجانا وفق ترخيص Apache-2.0.

أصول ذات صلة

مختارات أخرى في التطوير والبرمجة.

كل بدائل التوثيق ←
skillclaude_appclaude_codeclaude_api
git clone https://github.com/anthropics/skills && cp -r skills/skills/claude-api ~/.claude/skills/
واجهة برمجة تطبيقات Claude
مرجع ل Claude API / Anthropic SDK — معرفات النماذج، التسعير، المعاملات (params)، البث (streaming)، استخدام الأدوات، MCP، الوكلاء (agents)، التخزين الم…★ 4.8 · 2,500+
skillclaude_appclaude_codeclaude_api
npx skills add heygen-com/hyperframes
واجهة سطر الأوامر Hyperframes
واجهة سطر الأوامر (CLI) ل HyperFrames من job - لإنشاء الهياكل، والتحقق من الإطارات، وعرضها، وتعديل الجدول الزمني، والمعاينة، والتصيير محليا أو سحابيا،…1,214,920+
skillclaude_appclaude_codeclaude_api
npx skills add mattpocock/skills
تطوير مدفوع بالاختبار
التطوير الموجه بالاختبار. يستخدم عندما يرغب المستخدم في بناء ميزات أو إصلاح أخطاء بأسلوب "الاختبار أولا"، أو يذكر "red-green-refactor"، أو يريد اختبار…1,046,962+
skillclaude_appclaude_codeclaude_api
npx skills add mattpocock/skills
الشواء
استجوب المستخدم بلا هوادة حول خطة أو قرار أو فكرة. استخدمها عندما يرغب المستخدم في اختبار مدى متانة تفكيره، أو يستخدم أي عبارات تحفيزية مثل "استجواب".869,010+
skillclaude_appclaude_codeclaude_api
npx skills add mattpocock/skills
تشخيص الأخطاء
حلقة تشخيص للأخطاء الصعبة وتراجعات الأداء. تستخدم عندما يقول المستخدم "شخص/صحح هذا"، أو يبلغ عن شيء معطل/يصدر أخطاء/فاشل/بطيء.746,030+
skillclaude_appclaude_codeclaude_api
npx skills add mattpocock/skills
مراجعة الكود
راجع التغييرات منذ نقطة ثابتة (التزام، فرع، وسم، أو قاعدة دمج) على محورين: المعايير (هل يتبع الكود معايير الترميز الموثقة لهذا المستودع؟) والمواصفات (…696,572+

افحص قبل التثبيت

شغل أي مصدر عبر فحوصاتنا - الظهور في الذكاء الاصطناعي والأمان والأداء واكتشاف التقنيات.

المزيد في التطوير والبرمجة