Perl日記

PerlとかRubyとかPHPとかPythonとか

チケットタイトルアンチパターン

普段はBTS、JIRAとかRedmineとかのチケットでタスクを作っている。
その中で、いくつかチケットタイトルについて、アンチパターンを把握したので、メモ。

現状を書いただけで「だから何?」パターン

例)

  • 「ABC機能がX仕様に対応していない」
  • 「DEFアプリのY機能の矢印が動かない」
  • 「GをしたらZ機能ができない」


このパターンが一番多い
これらはすべて、「だから何?」と聞きたくなってしまう。
なんとなく、ニュアンスから類推することもできるのかもしれないが、それでも「じゃあ正解は何で何をすればいいのか」くらいは書いてほしい。
「対応していないのを対応させる」とか。

ログ貼り付けパターン

例)

  • 「Error: hoge feature: fuga abc def ghi jkl mno ...」
  • 「HogeException: AはBによってエラーになりました」


エラーログの内容をそのままとか、アラートで飛んできた件名とかを、そのままコピペで作ったパターン。
作ったときはいいものの、たとえば一週間後に見たときにすぐに内容が把握できるのかといえば、そんなことはない。
あと、当事者以外には触りたくない感じになる腫れ物チケットと化すことが多い。

エラーログは、チケットタイトルにちょっとはあってもいいけど、
全部をチケットタイトルにすると、結局何が失敗したのかわからない。
エラーログの内容はチケットの説明に書いて、チケットタイトルには何の失敗の対応をするのかを書こう。

漠然でふわふわ

例)

  • 「J画面の例のアレ」
  • 「今日のデータを取る」


もうちょっと頑張って書こうぜ。

【番外】ネタチケット

例)

  • 「もうすぐ到達するキリ番を取る」
  • 「↑のキリ番を取るのを防ぐ」


集計の邪魔になるので。