محفظة أعمال الكتابة الفنية
يجمع هذا الموقع عينات وثائق البرمجيات من محفظة أعمال الكتابة الفنية. يُنشئ Docusaurus كل صفحة من مصادر Markdown وMDX. وتشمل المجموعة أدلة المطورين ومراجع واجهات برمجة التطبيقات ووثائق المنتجات، إضافة إلى سير العمل وراء كل عينة.
التنقل في المحفظة
تصفح العينات حسب نوع المخرجات والمجال:
أدلة المطورين والأنظمة
- تثبيت سمة وتطبيقها على Google Chrome. دليل تدريجي لتخصيص المتصفح يتميز بعلامات تبويب تفاعلية لواجهة المستخدم وتصميم متجاوب.
- سير عمل من Microsoft Word إلى GitHub Wiki باستخدام Writage. دليل لكتابة Markdown في Word ثم تنفيذ تعديلات الويكي باستخدام GitHub Desktop.
- استخدام Postman للاتصال بواجهة برمجة تطبيقات Stripe. دليل للمصادقة وإجراء طلبات واجهة برمجة التطبيقات في Postman.
- إنشاء خادم وهمي في Postman. برنامج تعليمي عملي لتهيئة خوادم وهمية لاختبار تكاملات خطافات الويب ومخططات واجهة برمجة التطبيقات.
- توجيه سجلات تطبيقات السحابة إلى خط أنابيب. إجراء تشغيلي لاستيعاب وتصفية القياسات عن بعد لتطبيقات السحابة.
- كيفية استرداد بيانات الكائنات. برنامج تعليمي يشرح استعلامات قراءة RPC باستخدام حزمة أدوات تطوير البرمجيات Sui TypeScript SDK.
- استخدام عملية الكتابة لإرسال معاملة. دليل مطور لتوقيع وبث المعاملات القابلة للبرمجة.
وثائق البحث عن وظيفة باستخدام Sweepy
Sweepy أداة مفتوحة المصدر مكتوبة بلغة Python تستعلم أنظمة تتبع المتقدمين ولوحات الوظائف، ثم ترتب كل إعلان وظيفي مقابل سيرة ذاتية. تغطي المجموعة المكوّنة من 13 صفحة التثبيت وإعداد ملف التعريف وتقارير PDF وCSV وخادم Model Context Protocol (MCP) يشغّل عمليات المسح من مساعد ذكاء اصطناعي.
البدء
- تعرّف على Sweepy. يشرح ما يفعله المسح، ومراحل خط الأنابيب الخمس، وكيف يحتسب Sweepy نتيجة السيرة الذاتية.
- تثبيت Sweepy. يتناول تثبيت Python وGit والمستودع على Windows وmacOS وLinux.
- تشغيل أول مسح لك. يوضح كيفية إنشاء ملف تعريف وبدء مسح وقراءة مخرجات التقدم.
قراءة النتائج
- فهم نتائجك. يشرح بنية بطاقات PDF ونسب التطابق وشارات التقديم وأعمدة التتبع في CSV.
- السير الذاتية ونسب التطابق. يغطي تنسيق السيرة الذاتية للمحلل ومسار الاحتساب من السيرة إلى نسبة التطابق.
- شغّل Sweepy من مساعد ذكاء اصطناعي عبر MCP. يربط خادم MCP المدمج بـ Antigravity أو Claude Desktop أو VS Code.
يجمع فهرس وثائق Sweepy صفحات المراجع. ويغطي الأوامر ومفاتيح التهيئة وملاحظات المطورين ومرجع الأدوات. كما يسرد مصادر الوظائف والمنصات المدعومة.
مراجع واجهة برمجة التطبيقات (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.
دراسات الحالة
- تصميم Artie، مساعد توثيق يعمل بالذكاء الاصطناعي. دراسة حالة هندسية تحلل هندسة الأوامر وأمان OWASP LLM وهندسة استرجاع RAG.
لمراجعة مصادر Markdown الأولية لهذه المستندات، تصفح مستودع GitHub.
سير عمل «الوثائق كرمز» (Docs-as-code)
- التأليف بلغة Markdown وMDX باستخدام VS Code وAntigravity
- تدقيق النثر ودليل الأسلوب باستخدام Vale
- التدويل والترجمة باستخدام DeepL وLara
- تصميم مخططات بنية النظام باستخدام Mermaid
- كتابة وثائق منتج لأداة سطر أوامر وخادم MCP الخاص بها إلى جانب الشيفرة التي تصدرها
- التحكم في الإصدار ومراجعة التعليمات البرمجية التعاونية باستخدام Git وGitHub
- استكشاف واجهات برمجة التطبيقات والتحقق منها باستخدام Postman وSwagger/OpenAPI
- النشر المستمر باستخدام Docusaurus
الحزمة التقنية
- Docusaurus. يُنشئ مواقع ثابتة وأشرطة تنقل جانبية وإصدارات محلية.
- VS Code. يوفر بيئة التحرير الأساسية لتأليف Markdown وMDX.
- Postman. يتحقق من نقاط نهاية واجهة برمجة التطبيقات وينشئ أمثلة للطلبات والاستجابات.
- Vale. يدقق في النصوص التقنية لفرض إرشادات توثيق مطوري Google.
- Git وGitHub. يدير التحكم في إصدارات الفروع ونشر الموقع.
- Mermaid. يعرض المخططات الانسيابية ومخططات خطوط أنابيب البيانات.
- Python وMCP. يشغّلان محرك المسح في Sweepy وخادم الأدوات الذي يربطه بمساعدات الذكاء الاصطناعي.
- DeepL وLara. أتمتة ترجمة الوثائق إلى لغات أخرى.
لكل صفحة ملف Markdown أو MDX في المستودع نفسه. قارن المخرجات المعروضة بالنص الذي أنتجها.
تتبع كل عينة المسار نفسه من البحث والصياغة إلى الاختبار على مخرجات حقيقية ثم المراجعة والنشر.