مولّد ملاحظات الإصدار المجاني

ما هي ملاحظات الإصدار؟

ملاحظات الإصدار هي ملخص قصير لما تغير في إصدار جديد من منتج ما: الميزات الجديدة، والتحسينات، والإصلاحات، مكتوبة ليعرف القارئ ما يمكنه فعله الآن. يحوّل مولّد ملاحظات الإصدار القائمة الأولية التي يمتلكها فريقك بالفعل، مثل رسائل الالتزام أو التذاكر، إلى ذلك الملخص، بحيث تصدر الملاحظات مع الإصدار بدلاً من صدورها بعد أسبوع.

ملاحظات الإصدار الجيدة تخبر العملاء لماذا يهمهم التحديث. رسائل الالتزام تخبر المطورين ما الذي تغير في الكود. العمل يكمن في ترجمة أحدهما إلى الآخر.

ملاحظات الإصدار أم سجل التغييرات؟

يستخدم الناس الكلمات بشكل فضفاض. تقسيم مفيد:

تعمل هذه الأداة كمولّد لسجل التغييرات أيضاً: أنشئ ملاحظات لكل إصدار وأضفها إلى أعلى صفحة سجل التغييرات الخاصة بك.

ما الذي يجب تضمينه في ملاحظات الإصدار

• العنوان مع المنتج والإصدار: "ملاحظات إصدار Acme Analytics 3.2".
• ملخص من سطر واحد: التغيير أو التغييران اللذان يهتم بهما معظم القراء.
• جديد، مُحسّن، مُصلح: بهذا الترتيب، مع ترك الأقسام الفارغة.
• نقاط تركز على الفائدة: ما يمكن للمستخدم فعله الآن، وليس ما يفعله الكود.
• التغييرات الجذرية: ما يجب على الشخص فعله بالضبط، مع توضيحه بوضوح.
• الروابط: إلى مقال المساعدة أو الفيديو لأي شيء يحتاج إلى شرح.

مثال قصير لملاحظات الإصدار

ثلاث رسائل التزام، "feat: export reports to CSV"، و"fix: dashboard timezone off by one hour" و"chore: bump dependencies"، يمكن أن تصبح:

Acme Analytics 3.2
يمكنك الآن أخذ تقاريرك إلى أي مكان، وتظهر لوحات المعلومات الأوقات الصحيحة.

جديد

• تصدير CSV: قم بتنزيل أي تقرير كملف CSV لفتحه في Excel أو Google Sheets.

مُصلح

• أوقات لوحة المعلومات: تستخدم المخططات الآن منطقتك الزمنية بشكل صحيح.

تم استبعاد تحديث التبعية من نسخة العميل، لأن المستخدمين لن يلاحظوه. النسخة الداخلية تحتفظ به.

كيفية تحضير تغييراتك للمولّد

لا تحتاج إلى تنظيف قائمتك أولاً، لكن بعض العادات تعطي ملاحظات أفضل. ألصق تغييراً واحداً في كل سطر، سواء كان رسالة التزام، أو عنوان تذكرة، أو جملة. احتفظ بالبادئات التقليدية مثل "feat:" و"fix:" إذا كنت تستخدمها؛ فهي تساعد في تصنيف التغييرات إلى جديد ومُصلح. أضف كلمة سياق للعناصر الغامضة، على سبيل المثال "fix: export (CSV was empty for large reports)". املأ اسم المنتج والإصدار ليكون العنوان جاهزاً للنشر. ثم قم بتشغيله مرتين إذا كنت بحاجة إلى كلتا النسختين: مرة للعملاء، ومرة للفريق الداخلي.

أفضل الممارسات لملاحظات الإصدار

اكتب للشخص الذي يستخدم المنتج

"تحميل التقارير بشكل أسرع" أفضل من "مخطط الاستعلام المُحسّن". سمِّ الميزة كما تظهر في الواجهة.

ابدأ بما يهم أكثر

ضع التغيير الذي سيلاحظه معظم الناس أولاً. يمكن أن تكون الإصلاحات الصغيرة سطراً واحداً لكل منها في النهاية.

أظهر الميزة الجديدة

لقطة شاشة أو فيديو قصير لميزة جديدة يفعل أكثر من فقرة. اربط مقال المساعدة الذي يشرحها.

انشر في جدول زمني يمكن للناس العثور عليه

احتفظ بكل إصدار في صفحة سجل تغييرات واحدة، الأحدث أولاً، حتى يعرف العملاء وفريق الدعم الخاص بك دائماً أين يبحثون.

أخطاء شائعة في ملاحظات الإصدار

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

يتضمن المولّد فقط التغييرات من قائمتك ولن يضيف تواريخ لم تقدمها له، لكن تحقق من كل عنصر قبل النشر.