誰に向けて
・チーム開発でドキュメント作成する人
・手順書作るのが面倒な人
経緯
チーム開発でバグを発見。
メンバーにもシェアよう。
↓
バグチケット作成。
再現方法を記述。
↓
現場ではドキュメント作成は英語。
チームメンバーは多国籍。
文字だけだと伝わるか不安。
↓
世界に共通言語があればいいのに…
↓
gif画像を生成するツール「ScreenToGif」
https://freesoft-100.com/review/screentogif.html
gif画像がありました。
こちらはgif画像を作るためのフリーツールです。
使い方は省略します。
gif画像は「手順」を伝えるベストな手段の1つです。
速いし正確に伝わります。
gifの速さがわかる例
たとえば、
「Google Chromeで検索結果の文字列を全て赤枠で囲む手順」
を伝えたいときを考えます。
そんなときはないですが。
文字で伝えるとき
1.適当な文字列でGoogle検索する
2.検索結果の1番目を右クリック
3.「検証」を選択してDeveloperToolを開く
4.「Style」タブを選択する
5.「Style」タブ内の右上にある「+」ボタンをクリック
6.「h3>a」と入力
7.TABキーを押下
8.入力カーソルが点滅するのを確認
9.「border」と入力
10.TABキーを押下
11.「solid」と入力
12.ENTERキーを押下
13.「border-color」と入力
14.TABキーを押下
15.「red」と入力
16.ENTERキーを押下
長い。
あえてかなり刻んで記述しました。
これが、gif画像だとどうなるか。
↓
gif画像
圧倒的に速い。
「どこをクリックすればいいか」
「どう入力するか」
が文字よりわかりやすい。
ただ、入力する内容は補足で書いておくのが親切ですね。
コピペしやすいように。
gif画像が文字より伝わるのは、一次情報だから
あるできごとを誰かに伝えるとき、言語化した時点で二次情報になります。
1つのニュースの切り取り方がメディアによって異なるように、言語化は人によって異なります。
一方で、gif画像は誰が作っても同じになります。
言語化する前の一次情報だからです。
したがって、誰が見ても正確に伝わります。
メリット
・資料作成が圧倒的に楽
・すぐ伝わる
・漏れなく伝わる
・言語の壁がない
デメリット
・あまりに長い手順には対応できない
→見落としたとき、初めから再生する必要がある
「今どうやったんだ?」
ということがあります。
短い手順なら、最初から再生するのも苦じゃありません。
長い手順だと苦です。
おわりに
gif画像は便利です。
ただ、文字による手順も書いた方が親切です。
補足的に使いましょう。