مقدمة
مرحبًا بكم في ملف توثيقي
يقدم هذا القسم من ملف الكتابة الفنية الخاص بي نظرة شاملة على نماذج توثيق البرامج، والتي تم تأليفها ونشرها بالكامل في Markdown باستخدام Docusaurus. ستجد هنا أمثلة على أدلة المطورين، ومراجع API، ونظرة ثاقبة على سير العمل المستخدم لإنشائها.
أدلة التنقل
- تثبيت مظهر وتطبيقه على Google Chrome
- استخدام Postman للاتصال بواجهة برمجة تطبيقات Stripe
- Microsoft Word إلى GitHub Wiki سير العمل مع Writage
- توجيه سجلات التطبيقات السحابية إلى خط أنابيب
- البرنامج التعليمي: جلب بيانات الكائن
- البرنامج التعليمي: إرسال معاملة
مراجع واجهة برمجة التطبيقات
- وثائق واجهة برمجة تطبيقات Stripe
- وثائق واجهة برمجة تطبيقات Pet Store
- استيعاب الأحداث عبر واجهة برمجة التطبيقات المتدفقة
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
وثائق مفاهيمية/نظرة عامة
لعرض ملفات التخفيض الأولية لهذه المستندات، انتقل إلى GitHub.
سير العمل
- صياغة سير العمل باستخدام Markdown في VS Code
- فحص Markdown باستخدام Vale
- الترجمة باستخدام DeepL
- إنشاء المخططات باستخدام Mermaid
- إصدار المستندات باستخدام Git
- التحقق من صحة واجهة برمجة التطبيقات باستخدام Postman و Swagger/OpenAPI
- النشر باستخدام Docusaurus
الأدوات
- Docusaurus: لإنشاء الموقع الثابت والوثائق.
- VS Code: المحرر الأساسي لجميع المحتويات.
- Postman: لاختبار واجهة برمجة التطبيقات وإنشاء أمثلة لوثائق واجهة برمجة التطبيقات.
- Vale: لفحص الأخطاء وضمان الالتزام بدليل الأسلوب.
- Git/GitHub: للتحكم في الإصدارات والاستضافة.
- Mermaid Chart: لتحويل كود Mermaid إلى صور.
- DeepL MCP: لترجمة الوثائق إلى لغات متعددة.
يعكس هذا كيفية قيام الفرق المحترفة بصيانة بوابات وثائق المطورين مثل Docusaurus أو مولدات المواقع الثابتة المماثلة.
توضح كل قطعة عملية إنشاء الوثائق من البداية إلى النهاية: البحث ← الصياغة ← المراجعة ← النشر.