Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

esa.io への俺俺フィードバックルールを考えてみた #esa_io

概要

esa.io への俺俺フィードバックルールを考えてみた
※主に職場内および私個人での esa.io 利用のために考えた内容です

Markdown で投稿する

esa.io のお問い合わせ欄は Markdown 記法に対応しています。
プレーンテキストよりも、 Markdown を利用して定型文で書いたほうが
運営さんが内容を確認する際にかかる手間が大きく減るでしょう。

投稿テンプレート化

フィードバックを送る際に必要となる情報は毎回似かよっています。
また、フィードバック内容を確認する運営側も同じフォーマットで送ってもらったほうが
内容を把握しやすくなります。(と、予想します)

フィードバック用の投稿を保存

esa.io へのフィードバック用の投稿も通常の記事と同様に保存しておきます。
esa.io の運営にどんなフィードバックを送ったか」についてもチーム内の知識の一つです。

お問い合わせ欄への直接の投稿のみで情報を暗黙化せず、
可視化するために記事を作った方が良いでしょう。

投稿テンプレートの作成

以下のようになりました。
※ 1 行目はタイトル

/templates/feedback2esa/%{Year}/%{month}/%{day}/

## :musical_score: 概要
TODO: :bangbang::pencil2: 問い合わせタイトル

## :musical_note: 詳細
### :large_blue_circle: 追加を依頼したい機能
TODO: :bangbang::pencil2: 追加を依頼したい機能

### :ballot_box_with_check: 追加を依頼したい理由
TODO: :bangbang::pencil2: 追加を依頼したい理由。ユースケースを添える。

## :calendar: 送信日
%{Year}/%{month}/%{day}

## :man::woman: 送信者
%{name}

## :trophy: 完了
- [x] 未完了
- [ ] 完了(解決)
- [ ] 完了(未解決)

## :name_badge:  ReleaseNote
TODO: :bangbang::pencil2: 完了かつ解決の場合のみ運営のリリースノートへのリンクを張る

## :books: 外部資料
TODO: :bangbang::pencil2: 必要な場合に外部資料へのリンクを記述

投稿テンプレートを使ってみる

Revision 内でもEmojiを利用したい という要望を送ってみます。

Markdown

/feedback2esa/2015/01/29/Revision内でもEmojiを利用したい

## :musical_score: 概要
Revision内でもEmojiを利用したい

## :musical_note: 詳細
### :large_blue_circle: 追加を依頼したい機能
* Change log 入力時に Emoji を入力すると、 Revision の確認時に Emoji として表示される

### :ballot_box_with_check: 追加を依頼したい理由
* Emoji で変更内容を分かりやすく伝えたい
    * 変更種別を付与することで、ひとめで変更理由の分類が分かるようにできる
        * :recycle:   で修正(文言の誤りや文面の変更など)
        * :new: で追記
        * :x: で削除
    * Emoji を添えた方が伝わりやすい内容  
          :bomb: :bomb: :bomb:  
          :bomb: :walking: :bomb:  
          :bomb: :bomb: :bomb:  
* 楽しさ向上 :point_up: 

## :calendar: 送信日
2015/01/29

## :man::woman: 送信者
あなたのユーザー名が自動挿入される

## :trophy: 完了
- [x] 未完了
- [ ] 完了(解決)
- [ ] 完了(未解決)

## :name_badge:  ReleaseNote
TODO: :bangbang::pencil2: 完了かつ解決の場合のみ運営のリリースノートへのリンクを張る

## :books: 外部資料
TODO: :bangbang::pencil2: 必要な場合に外部資料へのリンクを記述

Image

f:id:tbpg:20150129221342p:plain

f:id:tbpg:20150129221343p:plain

フィードバックのワークフロー

  • Template を利用してフィードバック記事を作成
  • 記事が完成したら、 URL + .md で Markdown を表示する
  • 概要, 詳細 をコピーする ( その他は内部での情報管理用項目 )
  • 運営からリアクションがあり
    • 対応
      • 完了(解決) をチェック
      • Release Note へのリンクを追加
    • 不対応
      • 代替案あり
        • 完了(解決) をチェック
      • 代替案なし
        • 完了(未解決) をチェック

まとめ

esa.io の運営は少人数で日々増えるユーザーに対応しているだろうし、
問い合わせの質問内容がわかりにくいために、やりとりを何往復もしたり、
行間を埋めるために思考を巡らせるような本質的ではないやりとりで
彼らの貴重な時間を浪費したくない、という思いもあったりする。トノコト。