Kjerrأمثلة changelog
تستحق أن تُنسخ.
تشترك أمثلة changelog الجيدة في ثلاث صفات: عنوان يقول ما تغيّر، وجملة عمّا يستطيع المستخدم فعله الآن، وصراحة في ما سيأتي. في الأسفل أربعة منشورات، واحد لكل نوع من التغيير، ثم الفرق بين changelog وrelease notes، وقائمة تحقق.
أربعة أمثلة changelog، حسب الفئة
كتبنا كل مثال لمنتج خيالي، في الفئات الأربع التي يستخدمها قسم الإعلانات في Kjerr. انسخ الشكل، لا الكلمات.
ميزة جديدة
تسجيل الدخول بخطوتَين متاح الآن
يمكنك الآن حماية حسابك بخطوة ثانية عند تسجيل الدخول. افتح الإعدادات، ثم الأمان، وامسح رمز QR بأي تطبيق مصادقة، واحفظ الرموز الاحتياطية. ويستطيع مالك مساحة العمل أن يفرضه على كل عضو في الفريق. كان هذا من أكثر الطلبات على لوحتنا.
لماذا يعمل: يبدأ بما يستطيع المستخدم فعله الآن، ويقول أين يجده، ويقرّ بالطلب.
تحسين
التقارير تُحمَّل أسرع بثلاث مرات
أعدنا بناء طريقة حساب التقارير. الملخص الشهري الذي كان يُفتح في ست ثوانٍ على الحسابات الكبيرة يُفتح الآن في أقل من ثانيتَين، ونطاقات التواريخ الأطول من سنة لم تعد تتجمّد. الأرقام نفسها لم تتغيّر.
لماذا يعمل: يذكر رقمًا يلمسه القارئ، ويطمئنه أن البيانات هي نفسها.
إصلاح
أُصلح: تصدير CSV كان يُسقط الصف الأخير
في عمليات التصدير الأكبر من 10000 صف كان الصف الأخير مفقودًا. أُصلح الخطأ، وعمليات التصدير من اليوم كاملة. إن صدّرت تقريرًا كبيرًا في النصف الأول من أغسطس، فأعِد تشغيله.
لماذا يعمل: يقول ما الخطأ، ومن تأثر به، وما العمل. بلا مواربة.
إعلان
ما نعمل عليه هذا الخريف
نظرة قصيرة على الأشهر المقبلة، مبنية على أصواتكم. إشعارات Slack قيد التنفيذ. والتالي هو الوضع الداكن؛ وهي الفكرة الأعلى أصواتًا على اللوحة، وقد بدأ تصميمها. سنكتب هنا عندما يُطلق كل منها.
لماذا يعمل: يضبط التوقعات من دون تواريخ لا يمكن الوفاء بها، ويحيل إلى الأصوات.
تشريح منشور changelog ناجح
- العنوان: التغيير، لا رقم الإصدار. «التقارير تُحمَّل أسرع بثلاث مرات» تقول للقارئ هل يخصّه الأمر. «v4.12.1» لا تقول.
- الفئة. ميزة جديدة، أو تحسين، أو إصلاح، أو إعلان. تتيح التصفح والترشيح.
- ما تستطيع فعله الآن. جملة أو جملتان من منظور المستخدم.
- أين تجده. مسار في القائمة أو رابط.
- ما التالي. غالبًا لا شيء. وعندما يحتاج الإصلاح إلى إعادة تصدير أو تغيير إعداد، فقل ذلك صراحةً.
- أقرّ بالطلب. إن طلبه المستخدمون، فاربط الطلب. هذا أرخص دليل على أن الآراء تُقرأ.
Changelog مقابل release notes
سجل التغييرات (changelog) سجل جارٍ لكل التغييرات المهمة؛ وملاحظات الإصدار (release notes) وصف لإصدار واحد. سجل التغييرات قائمة للتصفح: منشورات قصيرة، الأحدث أولًا، واحد لكل تغيير. وملاحظات الإصدار مستند للقراءة: تجمع تغييرات نسخة معيّنة، وتشرح الكبيرة منها بلقطات شاشة، وتحوي خطوات التحديث أو الترحيل.
يكفي الفرق الصغيرة عادةً سجل التغييرات وحده، مع منشور أطول عندما يستحق الإصدار ذلك. أما المنتجات ذات التثبيتات المرقَّمة أو واجهات API فكثيرًا ما تنشر ملاحظات إصدار أيضًا وتربطها من كل منشور في سجل التغييرات.
قائمة تحقق قبل النشر
اقرأ المنشور كما يقرؤه مستخدم لم ير خارطة طريقك أبدًا.
- هل العنوان مفهوم من دون النص؟
- هل الجملة الأولى عن المستخدم، لا عن الفريق؟
- هل هناك رقم أو مسار أو لقطة شاشة حيث تنفع؟
- إن تعطّل شيء، فهل يُعرف من تأثر وما العمل؟
- هل الطلبات التي يجيب عنها المنشور مرتبطة؟
- هل سيعرف به من طلبوا، لا فقط من يمرّ بالصفحة صدفة؟
كيف تنشر مثل هذه المنشورات في Kjerr
قسم الإعلانات في Kjerr سجل تغييرات بالفئات الأربع أعلاه. تدعم المنشورات العناوين والقوائم والروابط والصور، وتشير إلى الأفكار التي تجيب عنها، ويمكن أن ترسل عند النشر بريدًا إلى المشتركين.
- فئات، وبحث بالنص والتاريخ، وتفاعلات بالرموز التعبيرية، وتعليقات.
- اشتراك بالبريد بعنوان مؤكَّد.
- الأفكار المرتبطة تظهر تحت المنشور؛ وحالة Shipped ترسل بريدًا إلى المصوّتين.
- الويدجت على موقعك يعرض الإعلانات نفسها في لوحة جانبية، مع عدد المنشورات غير المقروءة على الزر.
أسئلة وأجوبة مباشرة.
ما هو changelog؟
Changelog (سجل التغييرات) قائمة مؤرَّخة بتغييرات المنتج، الأحدث أولًا، مكتوبة لمن يستخدمونه. يقول كل منشور ما تغيّر، ومن يخصّه، وما الذي ينبغي فعله، إن كان ثمة شيء.
ما الفرق بين changelog وrelease notes؟
سجل التغييرات سجل جارٍ لكل التغييرات المهمة؛ وملاحظات الإصدار وصف لإصدار واحد. منشور سجل التغييرات بضع جمل. وملاحظات الإصدار قد تشغل صفحة، بلقطات شاشة وخطوات تحديث. وتنشر منتجات كثيرة الاثنين في المكان نفسه.
ما الذي ينبغي أن يحويه منشور changelog؟
عنوانًا يقول ما تغيّر، وفئة، وجملة أو جملتَين عمّا يستطيع المستخدم فعله الآن، وأين يجده، وأيّ إجراء مطلوب إن وُجد. وإن كان التغيير يجيب عن طلب، فقل ذلك واربطه.
كم مرة أحدّث سجل التغييرات؟
كل مرة تطلق فيها شيئًا قد يلحظه المستخدمون. منشور قصير كل أسبوع أو أسبوعَين يبني ثقة أكثر من منشور طويل كل ربع سنة.
أين ينبغي أن يكون سجل التغييرات؟
على صفحة عامة بعنوان خاص بها، ليمكن ربطها والبحث فيها وفهرستها، وفي بريد للمشتركين. يضعه Kjerr على اللوحة نفسها التي فيها طلبات الميزات.
صفحات ذات صلة
أعطِ مستخدميك جوابًا.
Kjerr مجاني خلال فترة الوصول المبكر، بكل الميزات ومن دون بطاقة ائتمان. وعندما تصل الخطط المدفوعة ستُحسب لكل مساحة عمل، لا لكل مقعد مشرف أبدًا.