テキストで伝える力

キーワード:TechBlog , システム開発 , テキストコミュニケーション

titile

最近、チームにジョインしてくれたメシア様。
Issueやチャットツールのやりとりで非常に分かりやすいテキストコミュニケーションをしてくれます。
※メシア様については下記を参照。

システム開発実録。メシア様参入事例。コンテキストと道標編

メシア様がSlackに書く文章。
Issueに書く説明、コメント。
どれも非常に分かりやすく、読んで理解するのに要する時間が非常に少ない。

ざっと確認したい課題などは、見出しと内容が綺麗にまとめられてるので見出し読みしても安心して読み流せます。
あまりに見事な文章に社内の複数のメンバーが声を上げて唸ることもままあります。

私とメシア様のSlackの分報上の会話

ほんのちょっとだけ抜粋

わたし: ・ 伝えるちから
わたし: ・ わかりやすく書くちから
わたし: 結構重要。これ、課題にかかわる人間全員が使う必要のある時間を大きく左右する。
メシア: 因数分解的な書き方が必要ってのはよく言われますよね。

因数分解

これはいい。ちょっと分解してみる。
メシア様ができていること。

  • コンテキストの明示
  • 分かりやすくアウトライン化された文章
  • 相手に合わせた説明
  • 用語の定義を明確にして使用
  • 曖昧な理解のまま書かない(曖昧な部分は別途、話題に出して追求する)
    • 事実を書く、ともいうか(逆に事実と予想を区別がつかないまま書いたり話す人、結構いる)
  • ただ書くだけではなく、読みやすい見た目について配慮している
    • 改行の位置
    • 行間
    • 長い1文よりも短い複数の文
    • etc
  • 対象を曖昧にしない
    • Issue 123, 項目Aなど対象を明確にする
  • 混みいった内容には具体例を添える
  • テーブル記法の活用
    • 表組みで説明すると分かりやすいものの判断
  • 後から参照する際のことを考える
    • 間違った記載は直す(Aさんはこちらが直すか「直してください」と指示しないと「次から気をつけます」で直さない)
    • 文章の間違えの指摘のやりとりなどを消す

とか。たぶん考えだすともっともっといっぱい出てくると思う。

サンプル

上記挙げた項目のいくつかについて掘り下げてみる。

コンテキストの明示

前提情報をしっかりと記載すること。
これにより情報が曖昧にならないようにしたり、一部のメンバーにしか通じない文章にならないようにする。
ただし、これ自体は記載量を増やすことになるため省略しても問題ないケースでは省略した方がよい。

分かりやすくアウトライン化された文章

Markdownなどによる記述に慣れている人にとっては自然と身についているかもしれないスキル。
見出しが分かりやすくアウトライン化されていると少し長い内容になっても読み手が理解しやすくなります。
また、適切な見出しがあると読み飛ばしをしやすくなります。

全くアウトライン化されていない「のっぺりとした長文」は読み手に大きな脳内メモリを要求します。

用語の定義を明確にして使用

ドメイン駆動設計のユビキタス言語とも通じますが、用語定義が曖昧だとあらぬ誤解を生みます。
この辺り、ドメイン駆動設計などを徹底している現場の用語管理がどうなっているか気になります。

混みいった内容には具体例を添える

複雑だったり、難しい内容にはできるだけ具体例をつけます。
抽象的な話だけで伝わるケースばかりではないので、こういったケースでは具体例を添えると良いです。

テーブル記法の活用

表形式でまとめたほうがすっきりと分かりやすくなるケースがあります。
逆にこのようなケースで表を使わずに文章で書き下した場合、非常に理解し難いものとなることが多いです。

外部資料

上へ戻る