نوشتن یادداشت انتشار با هوش مصنوعی
تغییرهای یک نسخه رو از روی کار تحویلشده بنویسید. کاربر میبینه چه چیزی براش عوض شده و تیم فنی میتونه نتیجه رو به اصلاح یا بررسی مربوط وصل کنه.
نوشتن یادداشت انتشار با هوش مصنوعی وقتی به کارتون میاد که تیم میدونه چه فایلهایی عوض شده ولی کاربر میخواد بدونه حالا چه کاری رو میتونه متفاوت انجام بده. اسکیل writing-changelogs از روی شواهدی که درباره یک نسخه بهش میدید، تغییر قابل دیدن رو پیدا میکنه. برای یک اصلاح، میتونید توضیح بدید کاربر قبلا کجا به مشکل میخورده و نتیجه بعد از اصلاح چیه.
فرض کنید بخش گزارشگیری تعمیر شده و حالا فایل بزرگ هم کامل ذخیره میشه. اگه این اصلاح فقط در کد ثبت شده و هنوز به دست کاربر نرسیده، تاریخ انتشارش رو نمیشه از روی تاریخ تغییر فایل حدس زد. این تفاوت رو میتونید در تحویل کار به تیم روشن کنید و وقتی نسخه واقعا منتشر شد، متن کوتاه مناسب کاربر رو از روی همون شواهد آماده کنید.
کاربردها
- در فهرست تغییرات، هر اصلاح مهم رو کنار تاریخ و نسخه مربوط ثبت کنید تا دوبار در دو بخش تکرار نشه.
- برای نسخه جدید مشخص کنید کدوم گروه از کاربرها اثری میبینن و آیا لازمه کاری انجام بدن.
- اگر روشی عوض شده، اول اقدام لازم رو بنویسید و در صورت وجود به راهنمای مهاجرت اشاره کنید.
- یک مشکل شناختهشده رو با توضیح وضعیتش ثبت کنید تا مطلب به خواننده القا نکنه که اون مشکل حل شده.
- برای قابلیت کنارگذاشتهشده، تاریخ حذف و راه جایگزینی رو که تیم تایید کرده کنار هم بیارید.
نصب و استفاده
- مجموعه technical-writer سازنده رو در ایجنتتون نصب کنید یا این اسکیل و راهنمای همراه technical-writing رو با هم بگیرید. اطلاعات نسخه و شواهد تحویل رو آماده کنید.
- بگید «از روی این تغییرها یک یادداشت برای کاربر بنویس. اصلاح گزارش منتشر شده، ولی گزینه خروجی تازه هنوز فقط در نسخه آزمایشی هست.»
- متن رو با نسخهای که کاربر واقعا میبینه بسنجید. تاریخ و بررسی هر مورد رو قبل از اضافه کردن به سابقه انتشار کنترل کنید.
سوالات متداول
منبع
ساخته riekelt. نام اصلی: writing-changelogs، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub