1. はじめに
スペースマーケットでWebエンジニアをしています。新卒のShotaです。
今回のテーマは「質問」です。
新卒エンジニアや初学者の多くは一人でタスクを完結することは難しいです。
そのため質問をする機会が生じるでしょう。
しかし、メンターの都合が合わない場合、非同期でコミュニケーションを取る必要があります。
この際、Slackを通じて質問しますが、相手が内容を理解しやすくなるように工夫しています。
この記事では、自分の経験を元に質問文の構成例を考えてみます。
2. 質問文のイメージ
Slackで投稿する質問文は、下記の構成で投稿しています。
タスクの概要
(チケット名/画像/リンクなど)
質問
(相手に聞きたい内容)
背景
(どのような経緯で課題に直面したか)
自分で調査したこと
(具体的な調査内容/実行してみたこと)
3. 質問文の各内容について
1. タスクの概要
施策などの具体的なチケット名のみを簡潔に書きます。
1~2行ほどで記載します。
リンクや画像がある場合は添付するとより伝わりやすくなります。
2. 質問
こちらも簡潔に書きます。
・ ~~について回答を頂きたいです。
・ ~~について教えて頂きたいです。
のように、自分が何に困っているか、どんなことを知りたいのかを明らかにします。
3. 背景
質問に至った経緯を詳細に書きます。
・ ~~について、仕様を確認するため、調査しています。
・ sortはStringを受け取る、という仕様が書かれたコードを確認したいです。
・ [リポジトリA]の中に該当の仕様があると考えました。
・ 現在、仕様が書かれたコードを見つけられていないです。
のように箇条書きで記載すると良いでしょう。
4. 自分で調査したこと
自分で試した内容を詳細に書きます。
・ [リポジトリA]内のコード[A.rb]を調査しました。
ここではある内容をソートするためのscopeが定義されていました。
ソートの条件に基づいてデータをソートしているものと思われます。
しかし、コードを追ってみたのですが、ソート条件に何を適用できるのかが分かりませんでした。
のように最初に箇条書きで調査対象を挙げた後に、詳細を記載するのが良いでしょう。
4. 質問をする上で考えておくべきこと
1. 質問に至るまでのルールを決める
まず、自分で考える時間が必要です。
そうすることで「自分でよく考えれば解決できる質問だった...」を防げます。
その後、１５分後も問題が解決していなければ、必ず人に聞くようにしましょう。
このルールは「15分ルール」としてエンジニアの間で広く知られています。
2. 自己解決することがある
質問文を作成している時間は、すでに15分経過した後ですが「自分で考える時間」に含まれます。
特に先述の「タスクの概要/質問/背景/自分で調査したこと」の構成で文章を作ることで
自分の頭の中が整理されます。これにより、自力で答えに辿り着けたことが何度かありました。
5. 最後に
今回は4つの構成で質問文を書く手法を紹介しました。
疑問を明確にすること、回答者の身になって質問することなど質問をする上で
重要なことは多くあります。しかし、自己解決が最善であることは、常に念頭におきたいです。
日々、質問の内容をレベルアップさせ自分で出来ることを確実に増やしていきたいですね🧑🏻💻
株式会社スペースマーケットでは、働く仲間を募集中です！
少しでもご興味があればこちらから採用情報をご覧ください💻
採用情報 新卒採用 エンジニア採用情報
スペースを簡単に貸し借りできるサービス「スペースマーケット」のエンジニアによる公式ブログです。 弊社採用技術スタックはこちら -> whatweuse.dev/company/spacemarket
Discussion