アカウント名:
パスワード:
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
>もっと上流の業務寄りな文書って必要だと思う。
ほんとこれ。「後から他人がサポートやメンテするときには実はほとんどコメントや自動作成ドキュメントなんてやくに立たない」
なぜなら「何をしているか」は分かっても「何をしたいか(したかったか)」がわからないから。
極端に抽象化した話、X+Y =Bしているのがわかっても、Xがなんなのか(リンゴなのか、速度なのか)、Bは何かわからなければドキュメントの意味がない。もっと言えば、Bがなにかわかっても「なんのためにBが必要で、システム全体の目的はなにで、Bはそのうちどういうものか」
これがわからんと意味がない。逆にこれさえわかれば、中身何ぞある程度自明だし、返るべき値がわかるから、デバッグするべきクラスや関数も自明になる。
とりあえずあなたはプログラミングに通じた人ではない、ということはよくわかった。
あなたのために(他の人には不要なので)一番基本的な点を指摘しておくと、ほとんどのプログラミング言語ではX+Y=Bとは書かないし、今ここでそう書く必要も無い。
こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば仕様書を書く時間が増えて全て解決するんだがなw
> こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば> 仕様書を書く時間が増えて全て解決するんだがなw
設計書をまともに書く人は、指摘されて修正することに安心を感じるんだけど、
たまに設計書に指摘すると揚げ足取りで足引っ張るとかいう人いるよね?間違いを指摘するのがめんどくさくなる。
> 設計書をまともに書く人は、指摘されて修正することに安心を感じるんだけど、
しかし残念ながらここは投稿内容を修正できないスラドなのであった。正当な指摘であっても本筋に関係なければ議論の邪魔と斬り捨てられても仕方ないと思う。ここはそういう場だよ。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
あつくて寝られない時はhackしろ! 386BSD(98)はそうやってつくられましたよ? -- あるハッカー
設計書と一言で言っても (スコア:3, 興味深い)
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
Re: (スコア:5, すばらしい洞察)
>もっと上流の業務寄りな文書って必要だと思う。
ほんとこれ。
「後から他人がサポートやメンテするときには実はほとんどコメントや自動作成ドキュメントなんてやくに立たない」
なぜなら「何をしているか」は分かっても「何をしたいか(したかったか)」がわからないから。
極端に抽象化した話、
X+Y =B
しているのがわかっても、Xがなんなのか(リンゴなのか、速度なのか)、Bは何かわからなければドキュメントの意味がない。
もっと言えば、Bがなにかわかっても「なんのためにBが必要で、システム全体の目的はなにで、Bはそのうちどういうものか」
これがわからんと意味がない。
逆にこれさえわかれば、中身何ぞある程度自明だし、返るべき値がわかるから、デバッグするべきクラスや関数も自明になる。
Re: (スコア:-1)
とりあえずあなたはプログラミングに通じた人ではない、ということはよくわかった。
あなたのために(他の人には不要なので)一番基本的な点を指摘しておくと、ほとんどのプログラミング言語では
X+Y=B
とは書かないし、今ここでそう書く必要も無い。
Re: (スコア:0)
こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば
仕様書を書く時間が増えて全て解決するんだがなw
Re: (スコア:0)
> こういう揚げ足取りで足引っ張るしか能がない人がいなくなれば
> 仕様書を書く時間が増えて全て解決するんだがなw
設計書をまともに書く人は、指摘されて修正することに安心を感じるんだけど、
たまに設計書に指摘すると揚げ足取りで足引っ張るとかいう人いるよね?
間違いを指摘するのがめんどくさくなる。
Re:設計書と一言で言っても (スコア:0)
> 設計書をまともに書く人は、指摘されて修正することに安心を感じるんだけど、
しかし残念ながらここは投稿内容を修正できないスラドなのであった。
正当な指摘であっても本筋に関係なければ議論の邪魔と斬り捨てられても仕方ないと思う。ここはそういう場だよ。