محفظة أعمال الكتابة الفنية
هذه محفظة مخصصة حصريًا للعينات المتعلقة بالبرمجيات من محفظة الكتابة التقنية الخاصة بي. وهي تقدم نظرة شاملة على عينات من وثائق البرمجيات، التي تمت كتابتها ونشرها بالكامل بلغة Markdown باستخدام Docusaurus. ستجد هنا أمثلة على أدلة المطورين، ومراجع واجهة برمجة التطبيقات (API)، ونظرة ثاقبة على سير العمل المستخدم في إنشائها.
التنقل في المحفظة
استكشف عينات التوثيق المنظمة حسب نوع المخرجات والمجال:
أدلة المطورين والأنظمة
- تثبيت سمة وتطبيقها على Google Chrome. دليل تدريجي لتخصيص المتصفح يتميز بعلامات تبويب تفاعلية لواجهة المستخدم وتصميم متجاوب.
- سير عمل من Microsoft Word إلى GitHub Wiki باستخدام Writage. دليل حول كتابة Markdown في Word، واستنساخ الويكي باستخدام GitHub Desktop، ونشر التعديلات.
- استخدام Postman للاتصال بواجهة برمجة تطبيقات Stripe. دليل للمصادقة وإجراء طلبات واجهة برمجة التطبيقات في Postman.
- إنشاء خادم وهمي في Postman. برنامج تعليمي عملي لتهيئة خوادم وهمية لاختبار تكاملات خطافات الويب ومخططات واجهة برمجة التطبيقات.
- توجيه سجلات تطبيقات السحابة إلى خط أنابيب. إجراء تشغيلي لاستيعاب وتصفية القياسات عن بعد لتطبيقات السحابة.
- كيفية استرداد بيانات الكائنات. برنامج تعليمي يشرح استعلامات قراءة RPC باستخدام حزمة أدوات تطوير البرمجيات Sui TypeScript SDK.
- استخدام عملية الكتابة لإرسال معاملة. دليل مطور لتوقيع وبث المعاملات القابلة للبرمجة.
مراجع واجهة برمجة التطبيقات (API)
- وثائق واجهة برمجة تطبيقات Stripe. مراجع واجهة برمجة التطبيقات للتكنولوجيا المالية والبنية التحتية للمدفوعات.
- وثائق واجهة برمجة تطبيقات Pet Store. مرجع واجهة برمجة تطبيقات REST معياري مصمم وفقًا لمواصفات OpenAPI 3.0.
- واجهة برمجة تطبيقات استيعاب السجلات في Datadog. مرجع واجهة برمجة تطبيقات متدفقة لإرسال بيانات القياس عن بعد المجمعة.
- مرجع Sui TypeScript SDK:
البنية المعمارية والوثائق المفاهيمية
- مقدمة إلى واجهة برمجة تطبيقات Stripe. نظرة عامة مفاهيمية على البنية التحتية المالية والكيانات الأساسية والمصادقة.
- مقدمة إلى واجهة برمجة تطبيقات Pet Store. نظرة عامة على خدمة Petstore REST ومخططات المصادقة باستخدام Swagger/OpenAPI.
- تدفقات الأحداث وخطوط أنابيب قابلية المراقبة. نظرة معمارية عامة على معالجة التدفق، والتوجيه عند الحافة، وتحويل البيانات.
- قبل أن تبدأ مع خطوط أنابيب قابلية المراقبة. دليل معماري يقارن نماذج توجيه السجلات لأنظمة المؤسسات.
- بنية SuiClient المعمارية. نموذج عقلي يشرح كيف تنسق عملاء RPC الموزعة استعلامات الحالة.
رسائل الالتزام وطلبات السحب
- إصلاح مصفوفة NumPy المرتبة حسب F. وصف طلب سحب مفتوح المصدر ورسالة التزام لحل مشكلات تخطيط ذاكرة المصفوفة.
- التفاضل عبر ak.mean في JAX. وثائق ورسالة التزام تشرح دعم التفاضل التلقائي في Awkward Array.
دراسات الحالة
- دراسة حالة المساعد الذكي Ask Artie. دراسة حالة هندسية تحلل هندسة الأوامر وأمان OWASP LLM وهندسة استرجاع RAG.
لفحص مصادر Markdown الأولية لهذه المستندات، تفضل بزيارة مستودع GitHub.
سير عمل «الوثائق كرمز» (Docs-as-code)
- التأليف بلغة Markdown وMDX باستخدام VS Code وAntigravity
- تدقيق النثر ودليل الأسلوب باستخدام Vale
- التدويل والترجمة باستخدام DeepL وLara
- تصميم مخططات بنية النظام باستخدام Mermaid
- التحكم في الإصدار ومراجعة التعليمات البرمجية التعاونية باستخدام Git وGitHub
- استكشاف واجهات برمجة التطبيقات والتحقق منها باستخدام Postman وSwagger/OpenAPI
- النشر المستمر باستخدام Docusaurus
الحزمة التقنية
- Docusaurus. يُنشئ مواقع ثابتة وأشرطة تنقل جانبية وإصدارات محلية.
- VS Code. يعمل كمحرر أساسي لتأليف Markdown وMDX.
- Postman. يتحقق من نقاط نهاية واجهة برمجة التطبيقات وينشئ أمثلة للطلبات والاستجابات.
- Vale. يدقق في النصوص التقنية لفرض إرشادات توثيق مطوري Google.
- Git وGitHub. يدير التحكم في إصدارات الفروع ونشر الموقع.
- Mermaid. يعرض المخططات الانسيابية ومخططات بنية خطوط أنابيب البيانات.
- DeepL وLara. أتمتة ترجمة الوثائق عبر لغات متعددة.
تعكس هذه البيئة بوابات المطورين الإنتاجية في شركات الهندسة الحديثة.
تعكس كل عينة عملية إنشاء التوثيق الشاملة من البداية إلى النهاية: البحث والصياغة والاختبار والمراجعة والنشر.