Orbit
شروحات الخط الزمني في Orbit
Annotations let you write context onto a project's timeline: the incident that started at 2am, the release that changed the checkout flow, the feature flag someone flipped. Six months later they are…
التعليقات التوضيحية تتيح لك كتابة السياق على الخط الزمني للمشروع: الحادثة التي بدأت في الساعة الثانية صباحًا، أو الإصدار الذي غير تدفق الدفع، أو علم الميزة الذي قلبه شخص ما. بعد ستة أشهر، يكون الفرق بين مخطط به خطوة غامضة ومخطط يمكنك شرحه.
حيث تعيش التعليقات التوضيحية
افتح Orbit، انقر على المشروع، واختر Timeline تحت مجموعة Observability في شريط علامات المشروع. تحمل الصفحة عنوان Timeline annotations وتصف نفسها بأنها تحديد الحوادث والإصدارات والمعالم والملاحظات على الخط الزمني للنشر الخاص بك.
الأنواع الخمسة
| النوع | استخدمه لـ |
|---|---|
| Incident | حدث عطل. الانقطاعات، تدهور الأداء، مشاكل البيانات |
| Release | شحنة ذات مغزى، خاصة تلك التي تستحق الشرح |
| Milestone | لحظة تستحق التذكر: يوم الإطلاق، الألف مستخدم الأول، هجرة مكتملة |
| Flag flip | تم تشغيل أو إيقاف علم ميزة، وهو تغيير يشبه النشر بدون نشر |
| Note | أي شيء آخر يستحق الكتابة |
يستحق Flag flip نوعه الخاص لسبب محدد. يغير تغيير العلم السلوك في الإنتاج دون إنتاج نشر، لذلك لا يترك أثرًا في سجل النشر. عندما تتحرك الأداء في يوم بدون نشر، فإن قلب العلم في أغلب الأحيان هو الإجابة، وفقط التعليق التوضيحي سيخبرك.
إنشاء تعليق توضيحي
- انقر على New annotation.
- اختر Kind.
- عيّن Occurred at. القيمة الافتراضية هي الآن، ويمكنك تأريخها بتاريخ سابق.
- اكتب Title، بحد أقصى 200 حرف.
- اختياريًا اكتب Body، بحد أقصى 4000 حرف، للملاحظات أو الروابط أو نص المراجعة اللاحقة.
- انقر على Create.
التأريخ بتاريخ سابق مهم. اكتب التعليق التوضيحي عندما يكون لديك الوقت، وعيّن الوقت لعندما حدث الشيء فعلاً، حتى يستقر في المكان الصحيح على الخط الزمني.
ضع الإجابة في العنوان، وليس في الفئة. "Checkout timing out for AU customers" مفيد في القائمة؛ "Incident" ليس كذلك، وشارة النوع تقول ذلك بالفعل.
التصفية
يوفر شريط التصفية في الأعلى All بالإضافة إلى كل نوع. التصفية إلى Incident يعطيك سجل الحوادث للمشروع في عرض واحد، وهو بالضبط ما تريده عند كتابة مراجعة ربع سنوية أو تحديد ما إذا كانت المشكلة المتكررة تتكرر فعلاً.
التثبيت على نشر
يمكن إرفاق التعليق التوضيحي بنشر محدد بدلاً من أن يكون مستقلاً. هذا هو كيف تربط النتيجة بالسبب: ينتقل التعليق التوضيحي مع النشر الذي تسبب فيه.
استخدمه للنمط الكلاسيكي للنشر الذي بدا جيدًا وتسبب في مشكلة بعد ساعة. ثبّت الحادثة على هذا النشر والاتصال مسجل بشكل دائم، بدلاً من العيش في ذاكرة شخص ما.
يتم نشر الحوادث
تعليقات الحوادث التوضيحية هي المصدر لقسم الحوادث في صفحة الحالة العامة الخاصة بك، إذا كان لديك واحدة مفعلة مع تشغيل Show recent incidents.
افترض أن أي شخص يمكنه قراءة تعليق توضيحي للحادثة. لا تضع أسماء العملاء أو بيانات الاعتماد أو تفاصيل النظام الداخلي أو اللوم فيه. اكتب الحساب الموجه للعميل في تعليق الحادثة التوضيحي واحتفظ بالتفاصيل الداخلية في تعليق ملاحظة توضيحي أو مستند مراجعة لاحق خاص بك. انظر Orbit Status Page.
كتابة تعليق توضيحي جيد للحادثة
أثناء الحادثة، اجعلها قصيرة وحقيقية:
- ما هو المتأثر، من حيث يستخدمها العميل.
- ما تعرفه، وليس ما تشك فيه.
- عندما ستحدّث بعد ذلك.
بعد ذلك، أضف نصًا يحتوي على الحل: ما كان السبب، ما الذي أصلحه، وما يمنع تكراره. هذا يحول التعليق التوضيحي إلى سجل دائم بدلاً من لقطة ساعة سيئة.
مقاومة الرغبة في التليين. "Checkout was unavailable for 40 minutes" يتقدم بشكل أفضل من "some customers may have experienced intermittent issues"، كبيان عام وكسجل خاص بك.
الحذف
كل تعليق توضيحي له عنصر حذف. يقول التأكيد ببساطة أن هذا لا يمكن التراجع عنه.
احذف الأخطاء الإملائية والنسخ المكررة. لا تحذف الحوادث لأنها محرجة: قيمة الخط الزمني هي أنها كاملة، والتاريخ الذي تمت إزالة الأيام السيئة منه لا يمكن أن يخبرك بأي شيء عن الأنماط.
قراءة الخط الزمني مقابل المخططات الخاصة بك
تؤتي التعليقات التوضيحية ثمارها عندما تضعها بجانب مقياس:
- تغيير خطوة في Web Vitals. تحقق من الخط الزمني للبحث عن إصدار أو قلب علم في نفس اليوم: انظر Orbit Web Vitals.
- قفزة في مدة البناء. ابحث عن معلم مثل ترقية التبعية أو إعادة هيكلة المستودع الأحادي: انظر Orbit Build Insights.
- مجموعة من عمليات النشر الفاشلة. عادة ما يشرح تعليق توضيحي للحادثة، وإذا لم يكن هناك واحد، فهذا بحد ذاته يستحق المعرفة.
إنشاء التعليقات التوضيحية تلقائيًا
يمكن إنشاء التعليقات التوضيحية من خلال Orbit API، مما يعني أن أدوات خاصة بك يمكنها كتابتها. هناك نمطان يستحقان الإعداد:
- يفتح نظام التنبيهات الخاص بك تعليق توضيحي Incident عندما يرسل إشعارًا لشخص ما، حتى يتم ملء الخط الزمني دون أن يتذكر أحد القيام بذلك.
- تكتب أدوات علم الميزة الخاصة بك تعليق توضيحي Flag flip عند كل تغيير، وهي الطريقة الوحيدة الموثوقة لإبقاء هذا السجل.
انظر Orbit API Tokens and the REST API للمصادقة ومرجع نقطة النهاية.
العادات التي تستحق البناء
تعليق توضيحي واحد لكل حدث، محدّث في النص. وليس خمسة تعليقات توضيحية تتتبع نفس الحادثة. يجب أن يكون الخط الزمني قابلاً للقراءة بنظرة واحدة.
علّق على الانتصارات الممله أيضًا. "Moved images to the edge" بجانب الأسبوع الذي انخفضت فيه نطاقك الترددي هو كيف تثبت أن العمل يستحق القيام به.
اكتبها في نفس اليوم. التعليق التوضيحي المكتوب بعد أسبوع يكون أكثر غموضًا وعادة ما يكون خاطئًا بشأن الوقت.
استكشاف الأخطاء
التعليق التوضيحي ليس على صفحة الحالة. نوعه ليس Incident، أو مفتاح Show recent incidents مغلق في إعدادات صفحة الحالة.
تم قطع العنوان. الرسائل النصية يتم تحديدها بحد أقصى 200 حرف. ضع التفاصيل في النص.
يظهر في المكان الخاطئ على الخط الزمني. قيمة Occurred at هي عندما حدث الحدث، وليس عندما كتبتها. احذف وأعد الإنشاء بالوقت الصحيح.
لا شيء مدرج. لم يتم إنشاء أي تعليقات توضيحية حتى الآن. حالة الفراغ تدفعك لتحديد إصدار أو حادثة أو معلم.
أين تذهب بعد ذلك
- Orbit Status Page لنشر الحوادث لعملائك.
- Orbit Releases لسجل الإصدار المستند إلى العلامات.
- Orbit Project Analytics لمخططات التعليقات التوضيحية توضح.