Q&A
質問のタイトルがかなり駄目です。「コードの添削依頼は良いか？」みたいなタイトルに変更してください。
teratailの使い方について
teratailでは、質問の際にコードを載せて添削をして頂くのはマナー違反でしょうか？
質問したいことのついでに添削を依頼するのではなく、添削を主とした質問です。
ホントですね。ご指摘ありがとうございます！
ｂ
回答9件
0
ベストアンサー
もちろん程度によりますが良いと思いますよ。
「実現したい機能があります！概要はxxです。コードください！」や、「コードをべたっと貼り付けて、全部わかりません！1から10まで解説お願いします！」よりは万倍マシといえるでしょう。
多少甘めなアドバイスかもしれませんが、
私はコードはエンジニアの命であり、コードが汚い奴は何やっても駄目で、一緒に仕事したくないとすら思っています。
なので、今は未熟でもコードを綺麗にしていきたいという想いがあって頑張っている人の心意気は汲み上げたいと思ってます。
（まぁ、質問者さんのPythonは私からすると畑違いなので回答がつきにくいかも知れませんが…）
ざっくりガイドラインを作ってみました。
Teratailのヘルプからも引用しますので合わせて見て下さい。
- 質問するときのヒント
- 推奨していない質問
- コードは背景が重要
コードは文章なので前後関係や状況で使う変数や書き方も変わります。
コードだけをベタッと貼り付けるような事はせずに、背景を出来るだけ説明するようにしてください。
- 何処に改善できそうな箇所があるかを書く
こういう状況ではAとBのどちらが重要ですか？私はこのように考えてAを選びました
…みたいに分析した跡があれば回答者側も見ていて気持ちいいですし、追体験しながら答えを選びやすくなります。
- 機密情報は管理しようね
うっかり会社の気密情報を漏洩させてしまっている質問は結構多いです。
回答を編集してもさかのぼって見れるので運営に泣きついて消してもらいましょう。
もちろん懲戒免職されても仕方のない行為なので、そんな事ないように細心の注意を払って下さい。
- コード量が多くなりそうな場合はGitHubへ
他人のコードをレビュー出来るような人は単価の高いリーダークラスの方が多いです。
丸投げが酷いようだと、これもトラブルの原因というかそもそもスルーされそうなので注意してください。
分量が多くなるようならGitHubに上げた後にオンラインの知人や勉強会、クラウドワークス等の場でお願いする形にしたほうが穏やかになるでしょう。
- ある程度は自分でも勉強出来るはず
「天は自ら助くる者を助く」ということわざがあり、自分で出来る事を最大限の事をやっている人は自然とまわりが助けてくれます。
同じ質問文を書かせても、自分でも努力している人の文は体裁は整ってなくても想いが伝わる事が多いように感じます。
リーダブルコードとかオススメなので読んで自習してみてください。
投稿2018/09/13 10:44
編集2018/09/13 11:41総合スコア21158
0
大量のコードを載せられて「もっと効率よく書けますか？」「潜在的なバグはありますか？」という質問は無視します。
部下に作業をさせるような質問の場合(敬語で書いている場合も含む)ついでに余計な一言を入れることもあります。
たとえばこんな感じの質問ですね。
「【至急】明日の夕方までに仕上げなければいけませんが、初心者でググってもいい方法をみつけられませんでした。忙しいのでお返事は明日になりますが、よろしくお願いします<(_ _)>。初心者なのでお手柔らかにお願いします。不快になられた方は回答いただかなくて結構です」
しかし例えば総当たりで問題解決しようとして「とてつもなく時間がかかります。この場合どうしたらいいでしょうか？」と聞かれた場合、「それは動的解決法を……」とコードを書くこともあります。
以下が重要であろうと思います。
- **質問者が問題点を理解していて問題が一つに絞られている **
- 実際に使われているコードの垂れ流しではなく、問題の再現する必要最小限のコードに絞られている
- 明らかにわかりきったもののみ省略されていて、そこを補えばコンパイル可能
投稿2018/09/13 23:50
総合スコア28660
同意します。特にこちら。
> 質問者が問題点を理解していて問題が一つに絞られている
よくある「このコードについて調べましたが、分かりません」で終わる質問にも同様の問題を感じています。
右も左もわからないのにコードを書いているとうまくいかなくて、どう調べたらいいのかもわからなくて頼ってしまいたくなる気持ちはわかります。
しかし、その場合は自分の書いているコードに比べて自分の知識が圧倒的に足りないんだと自覚して基礎を見直してほしいですね。
基礎が足りないのに壁ばかり上に伸ばしているといずれ破綻すると思います。
0
過去に、「こういう所に問題を感じているのだが、どう直せば良いかわからない」とか「（プログラムと言うよりフレーズについて）数行で書けて一応動くのだが、もっと短くならないか」みたいな質問はあって、特に違和感は無かったです。
コードだけ載せて、「改善すべきところがあれば添削してください」だと、「動くなら、それで別に良いんじゃないの？」と答えたいところです。
↑これと、上に挙げた例との違いは、問題意識があって、それに対して自分で知恵を絞ったどうかですかね。
投稿2018/09/13 12:42
総合スコア84505
0
一般論でいえば、
- やってほしいことだけを記載した丸投げの質問
- 問題・課題が含まれていない質問
に該当するかと。
「リファクタリングやってて、こういうところの直し方がよくわからないんですけど、どうやったらスマートに書けますか？」という質問ならギリギリ受け入れられるかもしれません。
いずれにせよ、人に添削してもらおうと考える前にやるべきことがたくさんあります。
まずは綺麗なコードを書く方法を学び、自分でリファクタリングしてください。
投稿2018/09/13 10:30
総合スコア30933
0
上記ヘルプには、次のように書かれています。
teratailについて知りたい
teratailは技術に興味のある人達が集まって、質問と回答を通してお互いに知識や情報を交換・共有する場所です。
プログラミングをする中で起きた解決できない課題について本当に困っている人をサポートすること、また、価値のあるコンテンツを世の中に残し届ける事を目的としています。
作業依頼のような投稿をして課題や仕事を無償でやってもらう場所ではありません。
「コードの添削依頼」は質問ではなく、作業依頼だと思います。
コードの改善点を尋ねるにしても、適切な質問の仕方があると思いますし、前述のリンク先にそれは書かれています。
Re: sasuke_killer さん
投稿2018/09/14 03:33
編集2018/09/15 00:32総合スコア18162
0
コードレビューに求める効果は、以下のようなものです。
コードレビュー(wikipedia)
・レビューで発見された同様・類似バグについてレビュー参加者内での共通認識を図ることができる。
・バグの隠蔽を減少させることが期待できる。
・レビューを行うことへの意識により、人に見せるコードを書くようになるため可読性が向上する。
・コーディング規約等に対する各自の認識のずれを修正することができる。
一般に、teratail での質問で
・コードの全体像
・コードの役割
・使用されるコーディング規約
が開示されることは稀です。
なので、teratail 内で完結できるのは、
「レビューで発見された同様・類似バグについてレビュー参加者内での共通認識を図ることができる」
のみです。
添削を主とした質問が上記に該当する例は稀なので、基本的には「適切な回答ができない」質問になるはずです。
回答者は適切な回答をしようとすると質問者にヒアリングをたくさんしなくちゃいけないんで、マナー違反とかそれ以前に疲れちゃいます。→疲れてエスパー回答しますｗ
逆説的ですが、全体像が整理されて提示されれば、「適切な回答ができる」面白い質問になる可能性はあります。
ただ、全体像が整理できるような質問者は、それなりにスキルの上がっている方なので、添削を主とした質問にはならないケースが多いです。
結論
「添削を主とした質問」には「適切な回答がつかない」
ただ、ファシリテーターがいれば面白い質問にできるかも。
投稿2018/09/14 04:20
退会済みユーザー
総合スコア0
0
ばーんとコードを書いて「よくわからないけど動きません、どこが悪いですか？」「もっといいコードがあると思いますが私には書けません。どう書けばいいですか？」（意訳）という質問は丸投げと捉えられてもおかしくないと思います。
他の皆さんも言っている通り、程度と態度の問題かもしれませんが。
推奨していない質問に「コードをください・デバッグしてください等の丸投げの質問」とあるので、単にデバッグを目的にした質問はteratailとしては本意ではないのでしょう。
ここから余談
どのような経緯でこの質問をしたのかが気になりました。
過去の質問でもご自身は「添削依頼/丸投げ」な質問はしていないように感じたので、「私の質問の仕方の何が悪いのか？」という意味合いの質問ではないですよね？
「今後そのような趣旨の質問をする気があったが、その前に是非を問おう」ということだったんでしょうか？
どちらにしろ、よくない質問には低評価がつくかスルーされるだけなのでそういう状態になったら「あ、この質問は良くなかったんだな…」と判断できます。自分の質問でも他人の質問でも。
投稿2018/09/14 00:51
総合スコア3235
0
「コードの添削をteratailで依頼するのはいいか」という質問をするのはいいんでしょうか？
嫌味で言うわけではないですけど、この手の質問をする度胸があるなら、サクッと添削の質問をしてしまえばよいのに。
通常、質問内容に迷いがある場合。
- teratailのヘルプなどを見て、teratailの趣旨に沿っているかを確認。
- 過去の質問を振り返って同様の質問はあるのかを確認。
- 回答者の反応はどうなのかを確認。
やりました？
それでもわからないなら「依頼してもいいのか」などというくだらない履歴が残るよりかは、質問をしてしまったほうがよいです。
で、質問の回答ですが、個人的にはありです。
投稿2018/09/14 00:10
編集2018/09/14 00:12
総合スコア16998
確かに、アンケートチックな内容なので微妙なところではありますね。
teratailタグがついてなければ低評価がついてるかもしれません。
全て確認したうえで質問させていただきました。
あ、ついでに聞きたいのですが、teratailタグのついた質問はどのようなものが好ましいと考えていますか？
teratailのタグがあること自体意味不明なのですが、使うとすればteratailの技術的な仕組みとかの質問ではないでしょうか。
僕は、teratailのタグはteratailというサービスについての質問をするタグだと思うのですが、どう思いますか？
その前のコメントで「使うとすればteratailの技術的な仕組みとかの質問」と書いているのになぜまた聞きますか？
例えば、teratailのサイトの仕組みはどうなっているのか、Markdown記法について、などが該当するかと思います。
ヘルプをご覧になっていればわかるはずですが、このサイトはプログラミングで困っている人を助けるためのサイトです。
teratailの使い方に困っている人を助けるサイトではありません。
僕の考えていることが貴方に伝わっているのかを確認しました。
1つ1つ挙げていったらキリがないので例として挙げたことは重々承知の上ですが、Markdown記法についてはMarkdownタグがあるので該当しないかと…。
実際のところ、どうなんでしょうかね…。気になるところです。
Markdownと言っても一般的なものとTeratailのものは若干異なるようですので、両方のタグを付ければいいんじゃないですかね。
実際のところタグ自体は単なる用語として存在するから登録されている程度の位置づけかと思います。
あとは質問者がサイトのルールに則って質問するだけですね。
なので、teratailのサービスに関する質問なら画面右下から送信することができるので、そちらにお願いしたいです。
添削の質問自体に関しては、丸投げにならないよう、自分なりの観点とか特に聞きたいところを十分に説明するようにしてくだされば、問題ないと私は思います。
なるほど…貴重なご意見ありがとうございました！
0
書き方に気を付ける必要があると思います。
それ次第で「デバッグ依頼」にもなってしまうからです。
既にあるように「コードの添削」となればある程度コードレビューの経験や知識が必要になってきます。
「私見になりすぎないように」気を付ける必要があります。
質問者さんも、そういった見ている人・回答する人の観点に立ったうえでの質問内容にする必要があるので質問力も結構必要になってきます。
自身でどのような目的で組んだコードなのかを具体的に説明し、方向性も明確にし、
「落とし所を明確にすること」「目標を明示すること」が必須になってくると思います。
つまり「あり」ですが、「依頼感」を出さないようにはしてもらいたいかなと、言うところですね。
投稿2018/09/13 23:22
総合スコア80850
あなたの回答
tips
プレビュー
