لماذا التوثيق مهم
توثيق واضح = مطورون سعداء.
التوثيق هو الواجهة الأساسية للمنتج، لذا فإن التوثيق الواضح والموجز وجيد التنظيم أمر ضروري. أنا كاتب تقني لدي خبرة في صياغة الوثائق التي تقلل من تذاكر الدعم والاحتكاك الهندسي وتحسن تجربة المستخدم.
الخبرات الأساسية
وثائق API و SDK
متخصص في واجهات برمجة التطبيقات (API) التي تعمل بنمط RESTful، ومواصفات OpenAPI/Swagger، ومجموعات Postman، والأدلة المرجعية الشاملة لمجموعات أدوات التطوير (SDK) التي تسهل عملية انضمام المطورين الجدد وتسرع عملية التكامل.
"الوثائق ككود" و"DocOps"
إجادة سير العمل القائم على Git، وMarkdown، ومولدات المواقع الثابتة (Docusaurus)، والتدقيق الآلي وفقًا لنمط Vale، والتحقق من صحة CI/CD للحفاظ على دقة الوثائق بمستوى يضاهي دقة البرمجيات.
الأدلة المفاهيمية والهندسية
متخصص في الرسوم التخطيطية التفاعلية لهندسة الأنظمة (Mermaid.js)، وإجراءات التشغيل القياسية (SOPs)، والأدلة المفاهيمية المتعمقة التي تُحوّل تصاميم البرمجيات المعقدة إلى نماذج ذهنية واضحة.
الذكاء الاصطناعي والتوثيق الذكي
تصميم مساعدين لتوثيق الذكاء الاصطناعي، وتنظيم قواعد المعرفة لاسترجاع نماذج اللغة الكبيرة (LLM) وتسهيل قراءتها من قبل البشر، وكتابة سير عمل مصممة خصيصًا لتوجيهات الأوامر لأدوات الذكاء الاصطناعي الحديثة.
هندسة المعلومات والتوطين
تنظيم تصنيفات المحتوى القابلة للتوسع، وتحسين مسارات التنقل للمطورين، وإدارة سير عمل الترجمة متعددة اللغات (i18n) عبر فرق الهندسة العالمية.