محفظة الكتابة التقنية

هذه محفظة مخصصة حصريًا للنماذج المتعلقة بالبرمجيات من محفظة الكتابة التقنية الخاصة بي. وهي توفر نظرة شاملة على نماذج توثيق البرمجيات، والتي تم تأليفها ونشرها بالكامل بلغة Markdown باستخدام Docusaurus. ستجد هنا أمثلة على أدلة المطورين، ومراجع واجهة برمجة التطبيقات (API)، ورؤى حول تدفقات العمل المستخدمة لإنشائها.

ملاحظة

لا يمكنني مشاركة معظم أعمالي بسبب اتفاقيات عدم الإفصاح (NDAs)، ولكن هذه المحفظة تتضمن محتوى أصليًا يوضح مهاراتي وعملياتي في الكتابة التقنية.

التنقل في المحفظة

الأدلة

• تثبيت وتطبيق مظهر على Google Chrome
• استخدام Postman للاتصال بواجهة برمجة تطبيقات Stripe
• تدفق العمل من Microsoft Word إلى GitHub Wiki باستخدام Writage
• توجيه سجلات تطبيقات السحابة إلى مسار بيانات
• برنامج تعليمي: جلب بيانات الكائن
• برنامج تعليمي: إرسال معاملة

مراجع واجهة برمجة التطبيقات (API)

• توثيق واجهة برمجة تطبيقات Stripe
• توثيق واجهة برمجة تطبيقات Pet Store
• استيعاب الأحداث عبر واجهة برمجة تطبيقات البث (Streaming API)
• SuiClient: getObject
• SuiClient: multiGetObjects
• SuiClient: getOwnedObjects

الوثائق المفاهيمية/العامة

• تدفقات الأحداث ومسارات بيانات القابلية للملاحظة (Observability Pipelines)
• قبل أن تبدأ
• بنية SuiClient

لعرض ملفات Markdown الخام لهذه الوثائق، توجه إلى 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 أو مولدات المواقع الثابتة المماثلة.

تعرض كل قطعة عملية إنشاء الوثائق من البداية إلى النهاية: البحث ← الصياغة ← المراجعة ← النشر.