Почему цитирование идентификаторов ошибок в патч-нотах считается плохой практикой?

На основе комментария и последующих отзывов от Ошибка повторного открытия против нового :

  

Сводка идентификаторов ошибок в примечаниях патча - это просто .. очень недружелюбно. - Krelp

Похоже, что некоторые люди считают, что ссылки на идентификаторы ошибок в патч-нотах не являются хорошей идеей. Я довольно неопытный разработчик, поэтому мне интересно, почему так.

28 голосов | спросил Travis Northcutt 30 MarpmFri, 30 Mar 2012 18:34:37 +04002012-03-30T18:34:37+04:0006 2012, 18:34:37

6 ответов


52

На мой взгляд, это хорошая практика, предполагая, что ваши пользователи имеют доступ на чтение к вашей базе данных ошибок. Есть много раз, когда люди ждут определенного исправления, чтобы решить, когда нужно обновить.

Я думаю, что на него нахмурился only со ссылкой на идентификатор ошибки и ничего больше. Вы всегда должны указывать описание, которое понятно, без перехода к трекеру ошибок. Это также позволяет вам переключать отслеживание ошибок в будущем без полной отмены ваших предыдущих заметок о выпуске.

ответил Karl Bielefeldt 30 MarpmFri, 30 Mar 2012 18:40:52 +04002012-03-30T18:40:52+04:0006 2012, 18:40:52
14

Это, как сказано в цитируемом комментарии ... недружелюбно.

Недружелюбие с самим собой

Представьте себе следующий сценарий. Вы просматриваете журналы в исходном элементе управления. Вам интересно, что изменилось. Вместо объяснения этого на простом английском языке он сообщает вам:

  

Решено # 1307

Вы запускаете систему отслеживания ошибок, надеясь получить что-то полезное. Сообщается, что ошибка № 1307 решена. В описании вы видите:

  

Такая же ошибка, как # 1284

Спасибо, очень полезно. Теперь вам нужно перейти к отчету об ошибке № 1284, чтобы прочитать, что это дубликат ошибки # 1113, который относится к ошибкам # 1112, # 1065 и # 1067.

Через пять минут вы не представляете, что вы ищете в начале.

A гораздо более полезное сообщение журнала управления версиями :

  

Устранена проблема с тем, что пользователи не могут войти в систему с паролем длиной более 25 символов (см. # 1307), удалив применение той же политики длины пароля к уровню доступа к данным, что и тот, который используется на самом веб-сайте.

Таким же образом в системе отслеживания ошибок отчет № 1307 может быть более понятным , напомнив, что такое отчет об ошибке № 1284 и как новый отличается от старый.

Недружелюбно с клиентами

Это не единственная проблема дружелюбия.

Вторым является то, что, ссылаясь слишком много, не имея дополнительной информации, вы делаете отчеты об ошибках /версиях управления журналами /ошибками отслеживания недоступными для тех, кто не очень хорошо знаком с этими системами . Когда вы ежедневно работаете с системой отслеживания ошибок, вы знаете, как быстро перемещаться по отчетам, просматривать несколько отчетов бок о бок и т. Д. Когда вы являетесь клиентом без технического фона, вы можете легко потеряться.

Здесь снова более подробные сообщения очень полезны, чем просто ссылки. Обратите внимание, что вы все еще хотите сохранить ссылки: ничего более неправильного, чем ошибка, которая является такой же, как ошибка, с которой вы столкнулись две недели назад, но не помните ее идентификатор.


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

ответил Arseni Mourzenko 30 MarpmFri, 30 Mar 2012 18:42:06 +04002012-03-30T18:42:06+04:0006 2012, 18:42:06
2

Нет ничего плохого в цитировании номеров проблем в примечаниях к патчам, если пользователи могут прочитать указанную проблему. Если ваша база данных ошибок позволяет кому-либо читать, цитирование номера ошибки может быть очень полезным. (Лучше, если ваши патч-ноты находятся в формате, который позволяет использовать ссылки, чтобы эти идентификаторы проблем были ссылками на рассматриваемый вопрос.) Это не означает, что вы должны раскрывать все проблемы для широкой публики; все же может быть полезно иметь те, которые окутаны (например, где у них есть действующие пароли!)

Ссылаясь на номер проблемы, в котором человек, читающий, не может пойти и посмотреть подробности и историю ошибки, это довольно недружелюбно. Не то, чтобы цитирование таких проблем без идентификатора проблемы было намного более дружелюбным.

ответил Donal Fellows 30 MarpmFri, 30 Mar 2012 18:40:51 +04002012-03-30T18:40:51+04:0006 2012, 18:40:51
2

Очевидно, что люди, которые будут читать заметки о патчах, и целевые пользователи программного обеспечения.

Но в большинстве случаев подавляющее большинство ваших пользователей просто не заботятся о том, что такое идентификатор ошибки. Им все равно, почему это было сломано, какое исправление или что-то еще - они только хотят знать, что изменилось с очень сжатым текстовым описанием, не переходя на другую страницу для каждого изменения.

Ссылаясь на идентификаторы ошибок, я останавливаюсь и думаю, и я - как пользователь - не хочу думать. Это своего рода проблема юзабилити.

Посмотрите, например, на журнал изменений Visual Assist X . Все эти связанные идентификаторы ошибок - это просто шум, который отвлекает меня от понимания того, что изменилось. И это дополнение для Visual Studio, ориентированное на программистов. И я программист. Если это беспокоит меня, представьте себе среднего пользователя, который даже не знает, что такое трекер ошибок.

PS: Я был автором комментария, вызвавшего вопрос

ответил Andreas Bonini 30 MarpmFri, 30 Mar 2012 19:26:23 +04002012-03-30T19:26:23+04:0007 2012, 19:26:23
1

Идентификатор ошибки обязательный для ориентира . Причины:

  • Предотвращение двусмысленности: У двух или более ошибок могут быть похожие описания. Поэтому для их различения потребуется некоторый якорь.
  • Удобство . При обсуждении ошибки, как с клиентом, так и внутри, идентификатор ошибки часто используется как короткая форма. Если идентификатор будет опущен из заметок патча, о них будет сложно обсудить:
  

3052 уже был исправлен, все еще работает на 3077

удобнее, чем:

  

«Ошибка приложения при нажатии на кнопку приложения» была исправлена, все еще работая над   «Исключение NullReferenceException при нажатии на пользователя изменения»

ответил KMoraz 1 PMpSun, 01 Apr 2012 12:49:30 +040049Sunday 2012, 12:49:30
0

Я бы сказал, это зависит от вашей системы: мне повезло, что тот, который я использую , автоматически обнаруживает такие ссылки в сообщениях фиксации и добавляет ссылку на билет , хранящийся в трекере ошибок, поэтому это не проблема.

Но если бы я был в системе, где он недоступен, я бы все же упомянул идентификатор билета (таким образом, вы можете быстро искать в журналах по идентификатору билета ) вместе с кратким описанием того, что ошибка.

ответил wildpeaks 30 MarpmFri, 30 Mar 2012 19:35:22 +04002012-03-30T19:35:22+04:0007 2012, 19:35:22

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132