はじめに
この記事について
リモートワークでテキストコミュニケーションをしていると、「これ何の話だっけ？」となることはありませんか？ Issue番号だけ書かれたメッセージ、リンクのない相談、表記が揺れている説明などなど、当事者同士はわかっていても、後から見た人や周りの人には何のことかわからないことがよくあります。
この記事では、「何の話かすぐわかる」テキストを書くための具体的な工夫を紹介します。
書く行為は1回ですが、読まれる機会は複数回（×複数人）あります。書くときに1回頑張っておくだけで、読まれるたびに何度も効果が発揮されます。やってみましょう。
書かないこと
以下についてはこの記事のスコープ外です。これらも大事なことではあるのでいつか書きたいですが、この記事の対象は情報伝達の内容というところに絞ります。
- レスの速さ
- 文章のスタイルや絵文字の使い方
- Slackのリアクションどう使うか
- メンション付けるか迷う場合は
- 相手の知りたいことを考えて書く
- テキストコミュニケーションの限界
- etc...
「何の話かすぐわかる」ための具体的な工夫
Issue や PR, チケットのタイトルは正確に書く
Issue番号やPR番号だけだったり、「朝会で話した修正のPR」のような曖昧なタイトルは避けましょう。
△: PR#1234 についてですが...
△: 朝会で話した修正のPRについてですが...
⚪︎: 「#1234 ログイン時のセッションタイムアウト処理を修正」についてですが...
正確なタイトルを付けておけば後から検索したときにも引っかかるので、「あの件どうなったっけ？」と探すときに役立ちます。
リンク先がある場合、かならずリンクを貼る
タイトルを正確に書くのに加え、PRのタイトルやIssue、Slackのメッセージなど、参照先がある場合はリンクを貼りましょう。ワンクリックで開けるから、読む人全員の一手間が省かれます。
△: 「ユーザーページからログアウトの動線をわかりやすくする」のレビューありがとうございます！
⚪︎: 「ユーザーページからログアウトの動線をわかりやすくする」のレビューありがとうございます！
Slack なら文字を選択してそのままペースト（Cmd or Ctrl + V）でリンクを貼ることができます。
当事者同士だけでなくふらっとそのやりとりを見かけた人にもなんのことかわかりやすいです。同様に、あとから見返した時に「これなんの話だっけ？」となったときにも役立ちます。
Option: リンク先を示す絵文字を付ける
絵文字を使うとリンク先が Slack なのか、Notionなのか、Pull Request なのか等わかりやすいので、これも必要があれば付けるようにしています。いちいちリンクを開いたりURLを確認しなくてもなんのリンクかわかるので便利です。
表記揺れをおさえる
これもちょっとしたことですが、投稿前に見返して同じ概念を指す言葉がばらついていないかを確認しましょう。
△: 初期データの投入に不具合があることがわかりました。既存のデータをクリアしてからseedしないといけないところ、初期化の処理が抜けていました。
⚪︎: seedに不具合があることがわかりました。既存データをクリアしてからseedしないといけないところ、データクリアの処理が抜けていました。)
まあ、「初期データの投入＝seed」「初期化＝データクリア」のことだとは考えたらわかるのですが、After のほうが「ん？」とならないはずです。ややこしい話であればあるほど効果を発揮します。
補足・おわりに
こういったことが当たり前だというチームも多いかもしれませんが、私は今の会社に入ってから学んだことだったので、誰かの役に立てばと思いあらためてまとめてみました。最初はちょっとめんどうに感じるかもしれませんが、結果的にみんながラクになると思いますのでぜひやってみてください。以下は補足です。
発信することが大事
いろいろ書きましたが、文章中で改善前の例を「△」としたのは理由があって、テキストコミュニケーションにおいては発信することが何より大事だと思っているためです。もちろん「わかりやすいテキストを発信できる」がベストですが、「わかりにくいテキストでも発信できる」もとてもいいことです。
「わかりやすいテキストが書けないから発信しない」は特にリモートワークにおいては悪手です。何か言いたそうにしている、というのが伝わらないし、フィードバックの機会も失われます。
チームで取り組もう
こういった習慣については個人個人が気を付けることでありますが、一番効果があるのはチームとして読み手に伝わりやすい書き方をするのは当たり前であるという雰囲気・文化を作ることでしょう。
チーム全体がこういうことができていたら、チームに新しく参加した人も自然とこのような振る舞いを身につけます。
Discussion