أداة توثيق مجانية لفرق الهندسة عن بُعد

Trupeer AI هي أداة توثيق خطوات العمل (walkthrough) لفرق الهندسة عن بُعد التي لا تستطيع الانحناء وطلب المساعدة من الشخص بجانبها. يقوم مهندس كبير بتسجيل الشرح مرة واحدة (كيف تعمل سلسلة النشر فعليًا، ولماذا تتعامل هذه الخدمة مع عمليات إعادة المحاولة بالطريقة التي تفعلها، وما الجزء الصعب في قاعدة الشيفرة ولماذا هو صعب)، ثم يقوم Trupeer AI بتوليد كلٍّ من فيديو ووثيقة هندسية مكتوبة في نفس المهمة. يشاهد المهندسون الآخرون ويقرؤون المحتوى بشكل غير متزامن من مناطق زمنية ومكاتب مختلفة. لا تعاني فرق الهندسة الموزعة كثيرًا من نقص ملفات READMEs بقدر ما تعاني من نقص الشرح الموجود خلف README، وهو الجزء الذي يستغرق مهندسًا كبيرًا فترة بعد الظهر لكتابته ولا يتوفر لدى أحد الوقت أو السعة لكتابته.

• يقوم مهندس كبير بتسجيل خطوات العمل. يصل الفيديو والوثيقة الهندسية المكتوبة معًا.

• مصمم لسير العمل غير المتزامن متعدد المناطق الزمنية الذي تعيشه فرق الهندسة الموزعة بالفعل.

• ترجمة التوثيق إلى 65+ لغة لفرق الهندسة الممتدة عبر الولايات المتحدة والهند وأوروبا وLATAM.

• يعمل جنبًا إلى جنب مع ويكي الفريق الحالي ومستودع الشيفرة ووثائق API. لا يستبدل أيًّا منها.

• التحديث عبر إعادة تسجيل الخطوة التي تم تغييرها. شرح البنية لا يخرج عن كونه مواكبًا للواقع.

ماذا ينتج Trupeer AI لفرق الهندسة

يقوم مهندس كبير بفتح تسجيل شاشة. يشرح عملية نشر خدمة الإنتاج، أو عملية تصحيح أخطاء بيئة الـ staging، أو يوضح خيار تصميم Message Queue الذي اتخذته الفرق في 2024. يتولى Trupeer AI مرحلة ما بعد الإنتاج. يتم حذف الكلمات الحشوية. وتُبرز تأثيرات Zoom أمر الطرفية (terminal command) أو منطقة IDE أو لوحة المعلومات التي يحتاج المهندس التالي إلى رؤيتها. يظهر مسودة فيديو ومسودة وثيقة هندسية مكتوبة في نفس المكان، مع لقطات شاشة وخطوات مرقمة داخلية.

يتم تسليم المخرجات كفيديو MP4 ووثيقة PDF أو Word. الوثيقة هي ما يقرأه شخص ما في الـ wiki أو يلصقه في Notion أو Confluence. أما الفيديوهات فهي ما يشاهده شخص ما في مركز المساعدة، أو يتم تضمينها داخل تذكرة Linear، أو مشاركتها عبر رابط Shared Page. يأتيان من نفس التسجيل دون الحاجة لتمرير ثانٍ. يتم تطبيق حزمة العلامة التجارية (brand kit) مع شرائح مقدمة وخاتمة مخصصة لفريق الهندسة، وتتعامل المسردات المخصصة مع أسماء الخدمات الداخلية وأسماء مكونات البنية التحتية والاختصارات التي قد لا يكتبها الذكاء الاصطناعي بشكل صحيح بخلاف ذلك.

كيف تعمل أداة توثيق الهندسة على ثلاث خطوات

ثلاث خطوات تغطي التدفق الكامل: تسجيل ما يفعله المهندس الكبير بالفعل في ذهنه، ثم السماح للذكاء الاصطناعي بتوليد كلا الصيغتين، وأخيرًا التسليم عبر رابط يمكن لبقية الفريق العثور عليه بغض النظر عن المنطقة الزمنية.

الخطوة 1: تسجيل الشرح

ابدأ تسجيل شاشة داخل المتصفح، أو داخل بيئة التطوير المتكاملة (IDE) الخاصة بفريق الهندسة، أو عبر الطرفية (terminal). يتحدث المهندس الكبير خلال العمل بالطريقة نفسها التي سيتبعها في جلسة 1:1 مع الموظف الجديد. عادةً ما تكفي من 5 إلى 10 دقائق من التسجيل لشرح بنية (architecture explainer) أو لتجربة نشر (deployment walkthrough). يعمل الذكاء الاصطناعي على ما تم تسجيله، لذلك لا يحتاج المهندس الكبير إلى كتابة مسودة أو تجهيز شرائح.

الخطوة 2: يقوم الذكاء الاصطناعي بتوليد الفيديو والوثيقة الهندسية المكتوبة

يتم إزالة الكلمات الحشوية ولحظات مثل "دعني أبحث عن هذا الملف". تُبرز تأثيرات Zoom الأجزاء المهمة من الشاشة (مسار الملف، مخرجات الطرفية، والاختلافات (diff) في مراجعة الـ PR). تظهر مسودة فيديو ومسودة وثيقة هندسية مكتوبة في المحرر معًا. يلتقط المسرد المخصص أسماء الخدمات الداخلية واختصارات المكونات قبل أن يتم نسخها بشكل خاطئ.

الخطوة 3: العلامة التجارية والترجمة والمشاركة

طبّق حزمة العلامة التجارية (brand kit) لتبدو الوثائق الداخلية للهندسة متسقة عبر مكتبة الفريق. ترجم إلى اللغات التي يعمل بها الفريق فعليًا: الإسبانية لمكتب مدينة مكسيكو، والهندية لفريق بنغالور، والبرتغالية لفريق ساو باولو. انشر عبر رابط Shared Page الموجود داخل الـ wiki، أو ضمن وثيقة الإعداد/التأهيل (onboarding) الخاصة بالفريق، أو الصقه مباشرة في سلاسل محادثات Slack حيث يمكن للمهندسين العثور عليه دون تعطيل سير العمل.

من يفتح أداة توثيق الهندسة هذه

الشخص الذي يفتح هذه الأداة غالبًا ما يكون مهندسًا في منصب staff، أو مدير هندسة، أو قائدًا تقنيًا في مؤسسة هندسية تعمل عن بُعد أولًا أو بنموذج هجين، مع وجود أشخاص عبر ما لا يقل عن منطقتين زمنيتين. يفتحها عند انضمام موظف جديد ولا تكون README كافية، عندما يتخذ الفريق قرارًا معماريًا غير بديهي يستحق تسجيل سبب اتخاذه، أو عندما يحتاج دليل التشغيل أثناء الاستدعاء (on-call runbook) إلى شرح ما يجب فعله عند الساعة 3 صباحًا بدلًا من مجرد سرد الأوامر. تستخدم بعض الفرق الأداة بشكل روتيني لكل قرار تصميم رئيسي؛ بينما يلجأ إليها البعض الآخر فقط عندما يظهر الفجوة التي يملؤها الشرح.

تظهر نفس سير العمل عبر الأدوار. يقوم قادة DevOps وSRE بتسجيل مراجعات ما بعد الحوادث (incident retros) وعمليات شرح البنية التحتية التي يتم مشاركتها مع مؤسسة الهندسة الأوسع. يقوم مديرو الهندسة بتسجيل خطوات تأهيل الموظفين الجدد حتى لا تُطرح نفس الأسئلة في الرسائل المباشرة كل أسبوع. يقوم القادة التقنيون بتسجيل قرارات البنية حتى يعرف المهندسون المستقبليون لماذا يبدو النظام كما هو. يقوم رؤساء الهندسة بتسجيل عمليات الإطلاق عبر فرق متعددة (منصة داخلية جديدة، أو ترحيل خدمة، أو تغيير في عملية النشر) والتي كانت ستتطلب خلاف ذلك اجتماعًا عامًا لجميع الحضور يضم 50 شخصًا لا يرغب أحد في حضوره.

أنواع المحتوى التي تتعامل معها هذه الأداة

أنواع المحتوى التي تظهر بشكل متكرر: شروحات خطوات العمل الخاصة بالمعمار والتصميم (لماذا يبدو هذا النظام بهذا الشكل)، وأدلة تشغيل النشر والبنية التحتية (كيف يتم النشر إلى الإنتاج، وكيف يتم التراجع)، وشروحات تأهيل الموظفين الجدد (جولة قاعدة الشيفرة، إعداد التطوير المحلي، أول جولة مراجعة PR)، ومراجعات ما بعد الحوادث وتحليلات ما بعد الوفاة (ما الذي حدث، ماذا تعلمنا، وما الذي سنغيره)، وشروحات مراجعة الشيفرة (السبب وراء PR غير بديهي). يتولى Trupeer AI التعامل مع جميع هذه الأنواع بنفس تدفق التسجيل إلى وثيقة. يتغير التنسيق حسب الحاجة: دليل تشغيل يريد خطوات مرقمة مع لقطات شاشة، وشرح بنية يريد الفيديو مع ملخص مكتوب، وجولة تأهيل تريد كلاهما.

وبشكل أوسع لتوثيق الهندسة، يملأ Trupeer AI طبقة الشرح التي تتركها أدوات الـ wiki النصية فقط فارغة. عادةً ما يقع توثيق هندسة البرمجيات في ثلاث طبقات: مراجع تولدها الشيفرة (Sphinx وjavadoc وOpenAPI)، ومحتوى ويكي الفريق (Confluence وNotion وSlab)، وشروحات يتم تسجيلها يدويًا. تمتلك معظم فرق الهندسة الطبقة الأولى لأنها تلقائية، والطبقة الثانية لأن شخصًا ما تم دفعه لكتابتها. أما الطبقة الثالثة (توثيق النظام في هندسة البرمجيات، توثيق مشاريع الهندسة، والتوثيق الداخلي في هندسة البرمجيات) فهي التي تتأخر دائمًا. يجعل Trupeer AI إنتاج هذه الطبقة الثالثة سريعًا بما يكفي بحيث يمكن لمهندس كبير إنجازها في يوم الجمعة بعد الظهر بين الاجتماعات.

أين يناسب Trupeer بجانب الـ wikis وأدوات توثيق الشيفرة ومولدات توثيق API

لا يستبدل Trupeer AI ويكي الفريق. تواصل Confluence وNotion وSlab وGitBook والويكي الداخلي للفريق القيام بما تقوم به. ينتج Trupeer AI محتوى الشرح المسجل الذي يتم تضمينه داخل تلك الـ wikis كـ Shared Page، إلى جانب المقالات المكتوبة التي يكتبها الفريق بالفعل.

كما لا يستبدل Trupeer AI مولدات توثيق API. تواصل Swagger وStoplight وRedoc وPostman وأي مراجع OpenAPI يتم توليدها تلقائيًا التعامل مع وثائق المراجع على مستوى الـ endpoint. يجلس Trupeer AI في طبقة مختلفة: شرح بشري لكيفية تصميم الـ API، وكيفية التكامل معه فعليًا، وما هي التعقيدات (gotchas) التي لا تظهرها وثائق المراجع. عادةً ما تريد مكتبة توثيق فريق الهندسة كلا الأمرين: المرجع الذي يتم توليده تلقائيًا والشرح الذي يتم تسجيله يدويًا. يتولى Trupeer AI التعامل مع الجزء الثاني فقط؛ ويبقى الجزء الأول في مكانه. تنطبق المنطق نفسه على أدوات مستوى الشيفرة مثل Doxygen وjavadoc وأنظمة التعليقات المضمنة، حيث يكمل Trupeer AI تلك الأدوات بدلًا من منافستها. وبالنسبة لإدارة توثيق الهندسة وبشكل أوسع للتوثيق التقني، يعني ذلك أن الفريق يضيف طبقة شرح دون اقتلاع أي شيء لديهم بالفعل.

التحديثات والترجمة لفرق الهندسة الموزعة عالميًا

يتعفن توثيق الهندسة أسرع مما تتوقعه الفرق غير الهندسية لأن الأنظمة الأساسية تتغير أسبوعيًا. يؤدي تغيير في سلسلة النشر إلى كسر دليل التشغيل (runbook) للربع الماضي، ويجعل إعادة هيكلة المعمار وثيقة التصميم مضللة، ويجعل تغيير اسم الخدمة شرح تأهيل الموظفين الجدد مربكًا. تتعامل معظم الفرق مع ذلك عبر السماح للوثائق بالابتعاد بهدوء عن الواقع والإجابة عن الأسئلة على Slack في كل مرة يصادف فيها شخص ما وثيقة أصبحت قديمة. يتولى Trupeer AI التحديث عبر إعادة تسجيل الجزء المتغير فقط. يعيد الذكاء الاصطناعي معالجة هذا الجزء وحده، مع تحديث الفيديو والوثيقة الهندسية المكتوبة في مكانهما، ويشاهد المهندس التالي الذي يفتح الـ wiki النسخة الحالية.

بالنسبة لفرق الهندسة الموزعة عالميًا، تقلل الترجمة الاحتكاك الذي لا يذكره أحد في الوقفة اليومية (standup). يصل نفس شرح البنية إلى فريق بنغالور باللغة الهندية، وإلى فريق برلين بالألمانية، وإلى فريق ساو باولو بالبرتغالية، من نفس تسجيل المصدر، وفي نفس الأسبوع. تنطبق الترجمة على كلٍّ من التعليق الصوتي للفيديو والوثيقة الهندسية المكتوبة، مع نقل حزمة العلامة التجارية والمسرد والنص الظاهر على الشاشة. إن دمج سير عمل توثيق فريق الهندسة هذا مع منشئ SOP الخاص بـ Trupeer AI يغطي كلا من شروحات خطوات العمل الموجهة للمهندسين والإجراءات التشغيلية القياسية متعددة الوظائف التي تسلمها فرق الهندسة إلى أجزاء أخرى من المؤسسة.