التوثيق

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

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

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

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

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

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

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

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

## المبادئ

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