מחולל הערות שחרור בחינם

מהן הערות שחרור?

הערות שחרור הן סיכום קצר של מה שהשתנה בגרסה חדשה של מוצר: פיצ'רים חדשים, שיפורים ותיקונים, שנכתבו כך שהקורא ידע מה הוא יכול לעשות עכשיו. מחולל הערות שחרור הופך את הרשימה הגולמית שכבר יש לצוות שלכם, כמו הודעות commit או כרטיסים, לסיכום כזה, כך שההערות יוצאות יחד עם השחרור ולא שבוע אחרי.

הערות שחרור טובות מספרות ללקוחות מדוע עדכון חשוב להם. הודעות commit מספרות למפתחים איזה קוד השתנה. העבודה היא לתרגם את האחת לשנייה.

הערות שחרור או changelog?

אנשים משתמשים במונחים האלה בצורה חופשית. חלוקה שימושית:

הכלי הזה עובד גם כמחולל changelog: צרו הערות לכל שחרור והוסיפו אותן לראש דף ה-changelog שלכם.

מה לכלול בהערות שחרור

• כותרת עם מוצר וגרסה: “הערות שחרור Acme Analytics 3.2”.
• סיכום בשורה אחת: השינוי או שני השינויים שהכי מעניינים את הקוראים.
• חדש, משופר, מתוקן: לפי הסדר הזה, תוך השמטת סעיפים ריקים.
• נקודות ממוקדות תועלת: מה המשתמש יכול לעשות עכשיו, לא מה הקוד עושה.
• שינויים שוברים: בדיוק מה שמישהו צריך לעשות, מצוין בבירור.
• קישורים: למאמר העזרה או לסרטון עבור כל דבר שדורש הסבר.

דוגמה קצרה להערות שחרור

שלושה commits, “feat: export reports to CSV”, “fix: dashboard timezone off by one hour” ו-“chore: bump dependencies”, יכולים להפוך ל:

Acme Analytics 3.2
כעת ניתן לקחת את הדוחות שלכם לכל מקום, ולוחות הבקרה מציגים את השעות הנכונות.

חדש

• ייצוא CSV: הורידו כל דוח כקובץ CSV כדי לפתוח אותו ב-Excel או ב-Google Sheets.

מתוקן

• זמני לוח בקרה: תרשימים משתמשים כעת באזור הזמן שלכם בצורה נכונה.

עדכון התלויות מושמט מגרסת הלקוח, כי המשתמשים לא יבחינו בו. הגרסה הפנימית שומרת אותו.

איך להכין את השינויים שלכם למחולל

אתם לא צריכים לנקות את הרשימה שלכם קודם, אבל כמה הרגלים יתנו הערות טובות יותר. הדביקו שינוי אחד בכל שורה, בין אם זו הודעת commit, כותרת כרטיס או משפט. שמרו על תחיליות קונבנציונליות כמו “feat:” ו-“fix:” אם אתם משתמשים בהן; הן עוזרות למיין שינויים לחדש ומתוקן. הוסיפו מילת הקשר לפריטים מעורפלים, למשל “fix: export (CSV was empty for large reports)”. מלאו את שם המוצר והגרסה כדי שהכותרת תהיה מוכנה לפרסום. לאחר מכן הריצו פעמיים אם אתם צריכים את שתי הגרסאות: פעם אחת ללקוחות, פעם אחת לצוות הפנימי.

שיטות עבודה מומלצות להערות שחרור

כתבו עבור האדם שמשתמש במוצר

“דוחות נטענים מהר יותר” עדיף על “Optimized query planner”. תנו שם לפיצ'ר כפי שהוא מופיע בממשק.

הובילו עם מה שהכי חשוב

שימו את השינוי שרוב האנשים יבחינו בו ראשון. תיקונים קטנים יכולים להיות שורה אחת כל אחד בסוף.

הראו את הפיצ'ר החדש

צילום מסך או סרטון קצר של פיצ'ר חדש עושים יותר מפסקה. קשרו את מאמר העזרה שמסביר אותו.

פרסמו בלוח זמנים שאנשים יכולים למצוא

שמרו כל שחרור בדף changelog אחד, מהחדש לישן, כדי שהלקוחות וצוות התמיכה שלכם תמיד ידעו איפה לחפש.

טעויות נפוצות בהערות שחרור

• הדבקת יומן ה-commit כפי שהוא, עם מספרי כרטיסים וז'רגון.
• הסתרת שינוי שובר באמצע רשימה.
• רישום כל שינוי פנימי בהערות ללקוחות.
• הבטחת תאריכים או פיצ'רים שלא נמצאים בשחרור.

המחולל כולל רק שינויים מהרשימה שלכם ולא יוסיף תאריכים שלא נתתם לו, אבל בדקו כל פריט לפני הפרסום.