همه محصولات

نوشتن یادداشت انتشار با هوش مصنوعی

تغییرات یک نسخه رو از نگاه کسی بنویسید که می‌خواد تصمیم بگیره به‌روزرسانی کنه یا قبلش لازم داره چیزی رو عوض کنه.

نوشتن یادداشت انتشار با هوش مصنوعی وقتی به کار می‌آد که فهرست تغییرات آماده است اما عنوان کارهای تیم به خواننده نمی‌گه بعد از نصب چه فرقی می‌بینه. اسکیل release-notes به ایجنت‌تون کمک می‌کنه اول تغییری رو پیدا کنه که ممکنه روش قبلی استفاده رو از کار بندازه. بعد قابلیت تازه، اصلاح خطا و دستور لازم برای به‌روزرسانی رو از هم جدا می‌کنه تا خواننده بتونه بخش مربوط به خودش رو زود پیدا کنه.

مثلا در نسخه جدید نام یک تنظیم عوض شده و یک گزارش هم سریع‌تر باز می‌شه. کسی که تنظیم قبلی رو داره باید قبل از به‌روزرسانی از تغییر اسم باخبر بشه. سریع‌تر شدن گزارش هم وقتی معنی داره که به رفتار قابل بررسی اشاره کنید. جمله مبهمی مثل «بهبودهای متعدد» به هیچ کدوم از این دو نفر کمکی نمی‌کنه. اگر زمان توقف یا روش برگشت هنوز معلوم نیست، همون مورد رو برای تایید تیم باز بذارید.

کاربردها

  • برای توضیح تغییر ناسازگار بنویسید چه چیزی از کار می‌افته، چه کسانی درگیرن و چه کاری لازمه.
  • در راهنمای ارتقای نسخه ترتیب کارها و پیش‌نیازها رو بر اساس روش انتشار تیم مشخص کنید.
  • برای معرفی قابلیت جدید نتیجه‌ای رو بنویسید که کاربر بعد از به‌روزرسانی می‌بینه.
  • در فهرست رفع اشکال، نشانه مشکل قدیمی و رفتار جدید رو در یک توضیح کوتاه کنار هم بذارید.
  • نسخه و تاریخ رو کنار هم نگه دارید تا معلوم باشه هر توضیح مربوط به کدوم انتشار بوده.

نصب و استفاده

  1. یک ایجنت نوشتن و اطلاعات تاییدشده نسخه، مثل شرح تغییرات و یادداشت مهاجرت، آماده کنید. اگر می‌خواید فایل موجود عوض بشه، همون فایل رو به ایجنت بدید.
  2. مثلا بگید «برای خواننده‌ای بنویس که از نسخه قبلی می‌آد. اول تغییر تنظیم رو توضیح بده و موردهای نیازمند تایید رو علامت بزن».
  3. قبل از انتشار، از صاحب تغییر بخواید ترتیب ارتقا و محدودیت برگشت به نسخه قبل رو بررسی کنه.

سوالات متداول

منبع

ساخته Arjun Prabhulal. نام اصلی: release-notes، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub