アカウント名:
パスワード:
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
>もっと上流の業務寄りな文書って必要だと思う。
ほんとこれ。「後から他人がサポートやメンテするときには実はほとんどコメントや自動作成ドキュメントなんてやくに立たない」
なぜなら「何をしているか」は分かっても「何をしたいか(したかったか)」がわからないから。
極端に抽象化した話、X+Y =Bしているのがわかっても、Xがなんなのか(リンゴなのか、速度なのか)、Bは何かわからなければドキュメントの意味がない。もっと言えば、Bがなにかわかっても「なんのためにBが必要で、システム全体の目的はなにで、Bはそのうちどういうものか」
これがわからんと意味がない。逆にこれさえわかれば、中身何ぞある程度自明だし、返るべき値がわかるから、デバッグするべきクラスや関数も自明になる。
とりあえずあなたはプログラミングに通じた人ではない、ということはよくわかった。
あなたのために(他の人には不要なので)一番基本的な点を指摘しておくと、ほとんどのプログラミング言語ではX+Y=Bとは書かないし、今ここでそう書く必要も無い。
こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば仕様書を書く時間が増えて全て解決するんだがなw
これはTypoの指摘や揚げ足取りじゃないだろ。たとえばIPv4の話をしている時に、アドレスの例として10.72.0.382とか言う奴がいたら、そいつの技術的見解や仕事の進め方についての発言に何の意味もない事はわかるだろう。十分に慣れ親しんでている人間なら気持ち悪さに耐えられないはずの事に気が付かないってことだから。そういう種類の間違いだと思うぞ。
> 10.72.0.38210.72.30.82 のtypoかもしれないし、間違う理由は人それぞれ。なのにたった一点を見て全体を判断する行為こそが愚かではなかろうか。
実際わたしの周囲にも、英語が苦手で、ディスクトップとかインストロールとかそういうレベルの単語を連発する人がいるが、その人のプログラムは群を抜いて優秀。その人のアウトプットのバグ率の低さは半端ない。でも毎年、新人は馬鹿にすんだな、その人を。すぐに認識を改めるけどさ。
>でも毎年、新人は馬鹿にすんだな、その人を。すぐに認識を改めるけどさ。
その人のことをもっと知りたいのでもっと紹介いただける部分があったらぜひ書いていただきたいです。
それはプログラミング言語ではなくて英語というか外来語の話でしょ。しかも発音の話。まさかその人disktopとかinstrollとか書いたり打ったりするの?
十分に経験のある人であれば、代入先を右に書いたり、1オクテッドが255を越えるアドレスを書いたりなんて事は指が拒否するだろう。いつもやってることなんだからわざとじゃない限りそういう間違え方は出来ない。野球経験者にバットを握らせたとき、どんなに慌てていてもどっちの手が上になるか間違えるなんて事はあり得ないのと同じ、
「綴りが正しいか」も「英語というか外来語の話」の一例に過ぎませんし、間違っててもそれは本質ではない、と思いますよ。IPアドレスだと無効な入力として「999.999.999.999」と設定するUIもたまに見るし、指が拒否するレベルかなぁ…?
APIの名前の綴りとか、実際に使用する値として不正値入れてたらそりゃダメだけど、単語自体が可読性以上の意味を持たない部分でのtypoや、例である事が明確な文脈での不正値も本質とは無関係だしどうでもいいでしょう。
ところで私は8ビットの単位をオクテットって覚えてるんですけど、オクテッ「ド」が正しいんですかね?
# あと代入先が右って言語や環境は主流ではないけど普通にありますよ。# 有名所だとアセンブラのAT&Tシンタックス。代入先などが右に来る。超キモい。
ね、気になるでしょう?octetをどう読んでも「ド」の音は出てきませんからね。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
皆さんもソースを読むときに、行と行の間を読むような気持ちで見てほしい -- あるハッカー
設計書と一言で言っても (スコア:3, 興味深い)
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
Re: (スコア:5, すばらしい洞察)
>もっと上流の業務寄りな文書って必要だと思う。
ほんとこれ。
「後から他人がサポートやメンテするときには実はほとんどコメントや自動作成ドキュメントなんてやくに立たない」
なぜなら「何をしているか」は分かっても「何をしたいか(したかったか)」がわからないから。
極端に抽象化した話、
X+Y =B
しているのがわかっても、Xがなんなのか(リンゴなのか、速度なのか)、Bは何かわからなければドキュメントの意味がない。
もっと言えば、Bがなにかわかっても「なんのためにBが必要で、システム全体の目的はなにで、Bはそのうちどういうものか」
これがわからんと意味がない。
逆にこれさえわかれば、中身何ぞある程度自明だし、返るべき値がわかるから、デバッグするべきクラスや関数も自明になる。
Re: (スコア:-1)
とりあえずあなたはプログラミングに通じた人ではない、ということはよくわかった。
あなたのために(他の人には不要なので)一番基本的な点を指摘しておくと、ほとんどのプログラミング言語では
X+Y=B
とは書かないし、今ここでそう書く必要も無い。
Re: (スコア:0)
こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば
仕様書を書く時間が増えて全て解決するんだがなw
Re:設計書と一言で言っても (スコア:0)
これはTypoの指摘や揚げ足取りじゃないだろ。
たとえばIPv4の話をしている時に、アドレスの例として10.72.0.382とか言う奴がいたら、そいつの
技術的見解や仕事の進め方についての発言に何の意味もない事はわかるだろう。
十分に慣れ親しんでている人間なら気持ち悪さに耐えられないはずの事に気が付かないってことだから。
そういう種類の間違いだと思うぞ。
Re: (スコア:0)
> 10.72.0.382
10.72.30.82 のtypoかもしれないし、間違う理由は人それぞれ。
なのにたった一点を見て全体を判断する行為こそが愚かではなかろうか。
実際わたしの周囲にも、英語が苦手で、ディスクトップとかインストロールとか
そういうレベルの単語を連発する人がいるが、その人のプログラムは群を抜いて優秀。
その人のアウトプットのバグ率の低さは半端ない。
でも毎年、新人は馬鹿にすんだな、その人を。すぐに認識を改めるけどさ。
Re:設計書と一言で言っても (スコア:1)
>でも毎年、新人は馬鹿にすんだな、その人を。すぐに認識を改めるけどさ。
その人のことをもっと知りたいのでもっと紹介いただける部分があったらぜひ書いていただきたいです。
Re: (スコア:0)
それはプログラミング言語ではなくて英語というか外来語の話でしょ。しかも発音の話。まさかその人disktopとかinstrollとか書いたり打ったりするの?
十分に経験のある人であれば、代入先を右に書いたり、1オクテッドが255を越えるアドレスを書いたりなんて事は指が拒否するだろう。いつもやってることなんだからわざとじゃない限りそういう間違え方は出来ない。
野球経験者にバットを握らせたとき、どんなに慌てていてもどっちの手が上になるか間違えるなんて事はあり得ないのと同じ、
Re: (スコア:0)
「綴りが正しいか」も「英語というか外来語の話」の一例に過ぎませんし、間違っててもそれは本質ではない、と思いますよ。
IPアドレスだと無効な入力として「999.999.999.999」と設定するUIもたまに見るし、指が拒否するレベルかなぁ…?
APIの名前の綴りとか、実際に使用する値として不正値入れてたらそりゃダメだけど、
単語自体が可読性以上の意味を持たない部分でのtypoや、例である事が明確な文脈での不正値も本質とは無関係だしどうでもいいでしょう。
ところで私は8ビットの単位をオクテットって覚えてるんですけど、オクテッ「ド」が正しいんですかね?
# あと代入先が右って言語や環境は主流ではないけど普通にありますよ。
# 有名所だとアセンブラのAT&Tシンタックス。代入先などが右に来る。超キモい。
Re: (スコア:0)
ね、気になるでしょう?
octetをどう読んでも「ド」の音は出てきませんからね。