SwiftUIの基本を身につけたい方はこちら

【質問チェックシート】プログラミングに関する質問での注意点を解説!

この記事では、プログラミングで質問する際の注意点などを解説しつつ、質問チェックシート的な感じで書いていこうと思います。
この記事を見て、メンターさんにより良い質問をできるようになりましょう!そして、今回はSlackを使う想定でやっていきたいと思います。

大前提

「こういうチェックシートを作るから、初心者が聞きづらくなるんだ。」って言われるとその通りなんですよね。この記事で色々と質問のテクニックを記載していますが、この通りにやらなければダメということではありません。

気軽にどんどん質問してもらっても大丈夫です。ただ、以下のことをしてくれたら嬉しいです。的な感じです。嬉しいし、解決に早く進むと思うので、質問する際は意識してくれたらと思います。

質問する前の確認

Google先生、ChatGPT先生に聞いてみたか

質問する前に、まずはChatGPT先生、Google先生に聞いてみてください。メンターさんに質問する内容をそのままChatGPTに一回投げてみるでもOKです。そのほうが早い時も全然あります。

そして、基本的にメンターさんも、質問を受けてその質問の内容を検索して教えています。結局プログラミングは検索力です。検索力さえ身につけられれば独創できちゃいます。

以下の記事で検索の仕方を事細かに説明しています。よかったらみてみてください。

【超検索力】現役エンジニアが使っている検索テクニックや検索方法を徹底解説

翻訳してみたか?

初心者あるあるなのですが、赤色のエラー文は宇宙人語に見えてしまいます。しかし、エラー文は基本的に英語で書かれています。笑(これがエラーアレルギー)

翻訳してみると、「〇〇が見つからないよ」とか「もうすでにそれは存在しているよ」とか意外とわかりやすいです。そもそもエラー文はそのエラーを解決する策や原因を書いているので、エラー文を見ればわかります。

これを繰り返すと、not findとか、alreadyという単語に慣れてきていつの間にかエラーアレルギーを克服しています。行き過ぎるとエラー中毒になったりもします笑(エラーがあるとワクワクしちゃう変人)

質問する時の確認

質問する文章で一番大事なのは具体的な情報です。具体的な質問ができているかをしっかりと確認しましょう。

エラーの情報について明確に連携しているか?

まず、

  • どのようなことをしたらエラーになったのか?
  • どこでエラーが出ているのか?
  • どのようなエラー文なのか?
  • どこまで調べたか?
  • どのような対応を行なったか?

をできるだけ連携しましょう。

エラー文はスクショがあればメンターさん側は楽になります。(文章がコピペできないというデメリットがありますが、最近のMacは画像から文章をコピペできるので問題なしです。)

何を知りたいのか。何がわからないのかを明確にする

まぁコレがわからないから質問しているみたいなこともありますが、もしわかりそうなら考えてみてください。

GitHubにプロジェクトをアップロードしているか?

GitHubの使い方がわかるのであれば、プロジェクトをGitHubにアップロードして確認してもらえる状況を作りましょう。

あと、初心者の方でよくあるのが、アップロードする階層が間違っていて、クローンしてみると実行できないというケースです。必ず自分の端末でもクローンできることを確認してみましょう。

GitHubにアップロードしていれば、エラーのクラス名と関数名、行数を連携すればメンターさんが確認してくれます。

礼儀正しく質問しているか?

ここはそこまで問題ないと思いますが、質問して自分が欲しい回答が返ってこなければ何も返さないという人が稀にいます。メンター側からすると悲しいです。。

長すぎないか?

上記のことを意識しすぎて質問がとても長くなってしまうことがあります。

そうするとメンターさんが読む気なくなって後回しになってしまうので、なるべく大体、30行以内にしましょう。改行も適度に入れてください。箇条書きとかうまく使ってくれるとさらに読みやすくなります。

コードブロック機能を使っているか?

Slackにはコードブロック機能があります。複数行の場合はコードブロックを使いましょう。文章中に変数や定数、関数名などを記述する際は、コードを使いましょう。

なるべくやってほしくないこと

パソコンの画面をカメラで撮ること

スマホで返信しているからか、パソコンの画面をスマホで写真を撮って送る方がいます。写真ではなく、スクショにしてください。

スクショテク

ちなみに、スクショに関しても、色々とテクニックがあります。

とりあえず、全画面スクショしておけば間違い無いです。色々な情報が載っててメンターさんからしてもありがたいスクショです。

ここだけ見て欲しいという時に使えるスクショです。

一番美しいスクショですが、影がついているため要領が大きいです。

上記のウィンドウスクショよりも、この影なしの方が良いです。

そして、スクショの際に、さらにcontrolを押しながらスクショすると、画像がクリップボードに保存されるので、デスクトップが汚くならないです。

さらに、Skitchというアプリを使うと、簡単に画像に対して文字や矢印を入れることができるので、より伝わりやすくなります。

Gyazoを使って画像を共有

プログラミングスクールで教えてもらったことなのかわかりませんが、Gyazoというサイトに画像をアップロードしてURLを貼り付けるという質問をよくする方がいます。

しかし、それだとリンクが切れて後からその画像が見えなくなってたりとかするので、あまり好きじゃ無いです。

画面録画の共有

数十秒の画面録画なら良いですが、5分も10分もある画面録画の動画を共有してくるか違います。メンターさんからすると、確定で時間が取られるので、あまり動画での共有はやめましょう。

テキストでもしっかりと記載した上ならOKです。動画だとテキストコピーができないので。

あと、アニメーションや、不具合の挙動とかなら動画でも良いかと思います。

最後に

ここまでつらつらと偉そう質問のポイントを書いてきましたが、上記のようなポイントを意識しすぎて質問回数が減るというのはあまりよく無いので、気軽に質問してください。

私の上司が、「私は同じことを何回も質問されても怒らないっていうポリシーがあります。」って言っててすごい神様だなと思いました。

自分もそれ見習ってますので、何回も同じ質問して覚えてください〜

評価