読者です 読者をやめる 読者になる 読者になる

Tbpgr Blog

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

テキストコミュニケーションスキル - 参照先がある場合はURLを併記する

情報共有

f:id:tbpg:20151215230728j:plain

テキストコミュニケーションにおけるリンク情報の取り扱いについて。

リンク情報の併記の必要性

何か外部にある情報を話題にする場合、「あのサイト」「あの記事」「あの資料」という
言葉だけを記載してあると、読み手はその情報を元にGoogleや該当情報がある社内の
情報共有ツールなどを検索し見つける手間が発生します。
逆にリンクが貼ってあれば、気になった瞬間に情報のソースをたどることができます。
話している側はリンク先の情報をもともと知っているので、この情報をのURLを
貼り付ける手間は大したことがありません。

また、効率の面以外にも参照先をみずに具体的な内容を把握しないまま
「あの情報」を二人でなんとなく思い浮かべながら会話が進んでしまうかもしれません。
この場合、認識のズレが発生する危険性もあります。

具体例

リンクがない場合

GitHubのIssueコメント欄のやりとりの例.

A: このcommitだけど、複数の修正が混在してるね
A: esaにgit commit作法のページがあるからみといて
B: うす!(どこのページかな。まぁ、あとで探そう)
A: クリアコードさんのところにもいい記事があったから見といてねー
B: うす!!(それも検索しなきゃ)

割り込み発生

C: Bくん、ちょっときて
B: はい、いまいきまーす

しばらくあと

B: あれ?なにか調べごとがあった気がするけど、まぁいいか。

次のプルリク時

A: またcommitに複数の修正が混在してるよ
A: こないだ教えたページみてないでしょ?ちゃんとみといて。
B: はい。。。(うわぁ、忘れてた)

リンク情報の明示以外のダメな点を含むやりとりですが、その点はスルーで。

リンクがある場合

GitHubのIssueコメント欄のやりとりの例.

A: このcommitだけど、複数の修正が混在してるね
A: esagit commit作法 ※リンク先はダミーのページがあるからみて。
B: うす!(すぐ開く)
B: おー!わかりやすいっすね、この資料。
A: だろ? (ドヤァ)
A: 読み終わったらスターつけるかコメント書いといてね。
A: それみて読んだかどうか確認するから
B: かしこまりー
A: クリアコードさんのところにもいい記事があったから見といてねー
A: クリアなコードの作り方: 意図が伝わるコミットのしかた B: あざーす!

次のプルリク時

A: お、いいね!ちゃんとcommit粒度が細かくなってるね。わかりやすい!
B: だろ? (ドヤァ)
A: 俺のマネすんな!
A & B: Hahahahahaha!! Yeah!(ハイタッチ)

外部資料