🖥

プログラミングの質問でのNGパターン (StackOverflow Terateilなどのオンラインで)

2023/09/01に公開

コードブロックを使わない

地のテキストでコードを書いてしまう。大変読みづらい。

質問文がガタガタ

質問文を見返すことがないのか、回答者が読みづらい状態でも気にしない。

コードを画像で載せる

コードを再利用できない。
回答者が問題を再現するためには画像から写経するしかない。

コードはテキストで載せよう。

コードを載せない

全部文章で説明してしまう。

例:

「Railsを利用しております。コントローラーからモデルを参照したところidを渡す部分でエラーが出てしまいます。idに固定値を渡したところOKと返ってきます。コントローラのメソッドを削除したところ別のエラーになりました。どなたか分かる方いますでしょうか(コード例なし)」

具体的なエラーを載せない

「うまくいきません」しか書かない。

  • エラーが起こるタイミング
  • エラーの内容

を記載しよう。

やりたいことを書かない、丸投げ

「以下のコードが動きません、お願いします」

(1000行のコードが続く)

できれば問題が再現する最小限のコードにまで落とし込んで質問してほしい。

コードをシンタックスハイライトしない

できればしてほしい。

質問タイトルが曖昧

例: 「pythonについて」

XY問題

https://ja.wikipedia.org/wiki/XY問題

XY問題とは「質問者が、本当に解決したい課題Xについて直接聞くのではなく、Yという二次的な課題を解決する方法を聞く」ことによって発生するコミュケーション上の問題を指す語である。これはヘルプデスクや技術サポート、ソフトウェア工学、カスタマーサービスなどの現場でしばしば見られる。
質問者はYによってXを解決することができると考えているが、しかし、Yを解決してもXは解決しないか、またはYは解決方法としては不十分であることが多い。本質的な課題を曖昧にしたり二次的な問題を持ち込んだりすることは、回答者に不要な苦労をさせたり、または不十分な解決方法が示されることにつながる。

チャットメンバー募集

何か質問、悩み事、相談などあればLINEオープンチャットもご利用ください。

https://line.me/ti/g2/eEPltQ6Tzh3pYAZV8JXKZqc7PJ6L0rpm573dcQ

Twitter

https://twitter.com/YumaInaura

公開日時

2022-12-12

Discussion