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