🕌

この人、仕事できる!と思われる、エンジニアのテキストコミュニケーションのコツ

に公開

はじめに

最近、質問をするよりも受けることが多くなりました。質問や相談を受けるのは嫌いではないのですが、対応にかなりの時間を使うことがあります。

そんな中で、質問や相談がシンプルでわかりやすくまとめられていると、すぐに対応できて助かることが多いです。それだけでなく、相手の意図を的確に伝える力は、チームの生産性向上や自身の評価にもつながります。

特にリモートワークが増える中で、テキストコミュニケーションの質がプロジェクトのスムーズな進行を左右する場面が増えています。

そこで今回は、私自身も意識しているテキストコミュニケーションのコツについてお話ししたいと思います。

1. 明確で簡潔な表現を心がける

質問や相談をする際には、できるだけ具体的に、かつ簡潔に伝えましょう。

悪い例:

バグがあるみたいなのですが、どうすればいいでしょうか?

良い例:

商品ページの価格が表示されないバグを発見しました。product.jsformatPrice()undefined を返しています。確認をお願いします。

ポイント:

  • 具体的な状況を伝える
  • 何を求めているのか明確にする
  • 余計な修飾語を省く
  • 該当箇所の情報を添える(ページURL、リポジトリのURLなど)
    • これは質問を受ける側にとって助かるだけでなく、質問する側にとってもスムーズに問題解決ができるメリットがあります。

2. 適切なフォーマットで伝える

質問や相談をテンプレート化しておくと、伝達がスムーズになります。

コピペで使えるフォーマット

件名: [対応依頼] 商品ページの価格が表示されないバグについて

お手すきの際にご確認いただけますでしょうか?

◼︎ 問題
- バグ: 商品ページの価格が表示されない

◼︎ 詳細
- `product.js` の `formatPrice()` が `undefined` を返している

◼︎ 該当ページ
https://xxx.xxx

◼︎ 該当箇所
GitHubの該当コミット: https://github.com/xxx/commit/xxxxxx

このようなフォーマットを用意しておくと、質問を受ける側もすぐに状況を把握でき、やり取りがスムーズになります。

3. 適切なツールを活用する

エンジニアのテキストコミュニケーションでは、目的に応じて適切なツールを使い分けることが重要です。

ツール 用途
Slack / Discord リアルタイムのテキストチャット、チーム内の軽い相談
GitHub Issues / JIRA タスク管理、バグ報告、プロジェクト進行
Pull Requestのコメント コードレビュー、変更の背景説明
Notion / Google Docs 仕様書・ドキュメントの整理
メール 公式な連絡、外部とのやり取り

4. コードや技術的な内容は適切なフォーマットで

Slack や GitHub では、コードを共有する際に 適切なフォーマット を使うことで、可読性を向上させられます。

インラインコード(...: console.log("Hello") のように短いコードを共有

コードブロック(...: 長めのコードやログを共有する際に活用

function add(a, b) {
  return a + b;
}
console.log(add(2, 3)); // 5

5. 論理的な構成を意識する

エンジニア向けのテキストでは PREP法STAR法 などのフレームワークを意識すると伝わりやすくなります。

6. 結論を先に書く

長い説明を読むのはストレスになるので、「最初に要点を伝え、その後で詳細を説明する」構成にすると、相手が素早く理解できます。


まとめ

明確で簡潔に伝える(余計な言葉を省く)
適切なフォーマットを使う(質問・相談を整理しやすくする)
適切なツールを使う(Slack, GitHub Issues, PRコメント)
コードは適切なフォーマットで共有(インラインコード, コードブロック)
論理的な構成を意識(PREP法, STAR法を活用)
相手に合わせた説明をする(初心者向け・経験者向け)
結論を先に書く(要点を先に伝え、その後詳細)
感謝を忘れない(対応してくれた人に対して「ありがとうございます」と一言添える)

  • 感謝を伝えることで、より良い関係を築けるだけでなく、次回以降のやり取りもスムーズになります。

エンジニアのテキストコミュニケーションは、単なる「伝える」ではなく「正確に伝わる」ことが重要です。特にリモートワークでは、テキストの質がチームの生産性に直結するので、意識して磨いていきましょう!

Discussion