Належна практика написання конспектів


12

При постачанні кожної версії програмного забезпечення ми повинні написати примітку до випуску. Наприклад, ось деякі терміни, які я додаю, коли пишу примітку до випуску:

  • Дата випуску
  • Помилка вирішена

Цього достатньо, чи є ще щось?


Це виглядає як дублікат programmers.stackexchange.com/questions/66377/…

1
не забувайте додані функції
щурячий вирод

Відповіді:


21

Я думаю, що подальші дії дадуть дорогу хорошим практикам

// Пов'язані з датою

  • Дата випуску

// Пов'язані з функціями

  • Особливості додано
  • Рекомендовані видалено
  • Особливості змінилися

// Помилка, пов’язана

  • Вирішені помилки
  • Нерозв’язані помилки

// Залежний залежність

  • Список залежності

// Тестування, пов'язане

  • Результати одиничного тестування
  • Результати тесту на прийняття

// Пов'язані з контролем версій

  • Примітка тегів
  • Редакційний номер

Також декілька разів варто виділити речі, які кінцевий користувач може захотіти змінити у своїх конфігураціях чи робочому процесі.

Більшість кінцевих користувачів не переймаються результатом тесту. Вони очікують, що вона буде якісною, незалежно від того, що йдеться в повідомленні про випуск.

Найголовніше, що стосується приміток до випуску, - це знати, що кожне додаткове речення втрачає ще 10% читачів. Тому ви повинні чітко визначити пріоритетність того, що ваші поточні користувачі повинні знати про випуск.


1
також кілька разів варто підкреслити речі, які кінцевий користувач може захотіти змінити у своїх конфігураціях чи робочому процесі
jk.

@jk. Так, ти маєш рацію. Я відредагував свою відповідь як ваш хороший коментар.
Md Mahbubur Rahman

Більшість кінцевих користувачів не переймаються результатом тесту. Вони очікують, що вона буде якісною, незалежно від того, що йдеться в повідомленні про випуск.
Генрік

Нотатки до випуску @Henrik можуть бути корисними для інших, крім кінцевих користувачів
jk.

5

Найголовніше, що стосується приміток до випуску, - це знати, що кожне додаткове речення втрачає ще 10% читачів. Тому ви повинні чітко визначити пріоритетність того, що ваші поточні користувачі повинні знати про випуск.


4
кожен рядок може втратити 10% випадкових, незацікавлених (або ледачих) читачів. Ці читачі - це ті, до яких не написані нотатки до випуску. Ті, хто піклується про те, що ви зробили, прочитають їх усі і дякують вам за кожний відповідний рядок - вам потрібно лише бути обережним щодо включення пуху, який дійсно потребує належної документації.
gbjbaanb
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.