大量のドキュメントは本当に必要なのか？無駄だなよ

1 ：デフォルトの名無しさん：2021/02/08(月) 03:32:53.15 ID:JYkDV+U9.net

高品質なソフトほどドキュメントは少ない

Why you need ARCHITECTURE.md
https://www.reddit.com/r/programming/comments/le46br/why_you_need_architecturemd/

13 ：デフォルトの名無しさん：2021/02/14(日) 00:13:24.81 ID:0ZOTyIFU.net

ドキュメンテーションが苦手で、コーティングが得意なんていうのは、仕事ではありえないんだよな。

14 ：デフォルトの名無しさん：2021/02/23(火) 09:16:11.85 ID:KorSI7L1.net

得意苦手というよりは、特定のドキュメントが存在することで誰が得するの？って話では？
特定のドキュメントって具体的に何なのかは知らないけど

15 ：デフォルトの名無しさん：2021/02/23(火) 15:42:19.69 ID:Adetb3EO.net

NECとかに要求される大量のExcelファイルは本当に無駄だと思う

16 ：デフォルトの名無しさん：2021/02/23(火) 17:34:52.62 ID:c7t5V9po.net

極端に一時的な資料になっているドキュメントも困る。

17 ：デフォルトの名無しさん：2021/02/23(火) 17:43:14.11 ID:0iI/BmGY.net

コードが完成してから書くドキュメントには価値がある

18 ：デフォルトの名無しさん：2021/02/23(火) 17:50:04.63 ID:NOTz+wKC.net

>>16
誤解のない意思疎通のために必要なら
一時的なものでもドキュメント書いた方が結果的に安上がり

ルールとか規約のためだけに書いてるものはだいたい無駄

19 ：デフォルトの名無しさん：2021/02/23(火) 19:28:10.56 ID:82+bZbmq.net

>>17
各ファイルのステップ数とか書き込むExcelとかに？

20 ：デフォルトの名無しさん：2021/02/23(火) 20:09:46.89 ID:JuUT33rQ.net

>>19
そういうのは自動生成すればいいだけだからどうでもいい

21 ：デフォルトの名無しさん：2021/02/24(水) 09:11:56.42 ID:LkxISfys.net

>>18
作って放置して逃げてきた自覚がありますか？

22 ：デフォルトの名無しさん：2021/02/24(水) 09:20:29.14 ID:cUgjNbyW.net

ほとんど仕様どうりに作れない、特に今は

23 ：デフォルトの名無しさん：2021/02/24(水) 12:25:09.13 ID:/ijFpzJL.net

Linux界ではよくソースが仕様書と言われます。

24 ：デフォルトの名無しさん：2021/02/24(水) 14:34:55.93 ID:cUgjNbyW.net

枯れてるJavaとかならなぁ、flutterとかだと新しいプラグインで「あーこんなやり方あるの？/できないの？」みたいな事も多いからなぁ
ListView.builderの中のListView.builderとか一工夫必要だしなぁ
API mockでプロトタイプアプリ作ってエンドと合意してから要件他まとめる感じ

25 ：デフォルトの名無しさん：2021/02/24(水) 17:07:52.91 ID:fxCeKAet.net

linux kernel読むのにソースだけ読み始めても無理があるだろ。
明らかにドキュメントが必要だし、実際役に立ってる。

26 ：デフォルトの名無しさん：2021/02/26(金) 03:55:10.19 ID:5d4w5oMJ.net

>>24
地図のZ社のカーシェアアプリ？

27 ：デフォルトの名無しさん：2021/02/26(金) 05:54:24.34 ID:K8Xef+5I.net

Ruby では、ソースコードのクラス定義やメソッド定義箇所に、

YARD の記法に従いコメントをつけることで、自動的に文書が作られる

28 ：デフォルトの名無しさん：2021/02/26(金) 09:46:35.99 ID:/ZYd6oEI.net

>>14
コード書かない人が仕事したことを装う為に必要

29 ：デフォルトの名無しさん：2021/02/26(金) 11:12:08.06 ID:JSIqicAG.net

>>28
書かせるのが仕事なんだから
コード以外にもたくさん書かせたほうが仕事ができる男なんだよ

30 ：デフォルトの名無しさん：2021/02/26(金) 11:13:03.78 ID:KlI32NiE.net

役に立つドキュメントを書ける人とそうでない人がいる

31 ：デフォルトの名無しさん：2021/02/26(金) 13:38:55.78 ID:WvFkELqd.net

>>30
これはそうだな
本当に役立つドキュメントを書ける人は20人に1人もいない

32 ：デフォルトの名無しさん：2021/02/26(金) 14:09:11.03 ID:GphNZQIs.net

まあそれはコードでも同じなんだが、コードの場合糞でも動くってところが厄介。

33 ：デフォルトの名無しさん：2021/02/26(金) 14:46:17.25 ID:MVwmWMo6.net

ドキュメントはクソでも動かさないから修正されない
ドキュメントこそクソができないようにレビューしなければいけないのだが
クソでも動かさないから間違っていても客から文句は言われないのでレビューもしない
ドキュメントがクソだとコードはクソにしからない、これはドキュメントのせい
ドキュメントがクソ方がもっと厄介

34 ：デフォルトの名無しさん：2021/02/26(金) 14:51:22.12 ID:RFmyNSeu.net

そだよ
上流ドキュメントの質が一番重要だから君たちより高い金もらって
ドキュメントだけ書いてあとは君たち下請けに投げてるんじゃないか
クソの下請けがクソにしかならないのは当たり前

35 ：デフォルトの名無しさん：2021/02/26(金) 14:52:39.36 ID:MVwmWMo6.net

>>34
だからドキュメントのレビューさせろって言ってるんだが？

36 ：デフォルトの名無しさん：2021/02/26(金) 16:04:06.59 ID:GphNZQIs.net

>>34
糞しかできないんじゃその高級なドキュメントとやらに価値はないがな。

37 ：デフォルトの名無しさん：2021/02/26(金) 17:17:33.51 ID:HGT/q+n3.net

>>36
そだよ
客は本当の価値なんて分からないから下請けがクソでしたってことにして清算するだけ
本当の価値に対して金が動くわけじゃないから

38 ：デフォルトの名無しさん：2021/02/26(金) 17:23:04.47 ID:HGT/q+n3.net

>>35
すればいいじゃんw
レビューすらさせて貰えないのは君の会社の管理体制の問題だろ
その程度の交渉力すらないならドキュメントの質に関係なくクソ確定だよ

39 ：デフォルトの名無しさん：2021/02/26(金) 18:04:11.49 ID:MVwmWMo6.net

ドキュメントの内容が正しいか
ちゃんとテストしましたか？
テストは重要ですよ

40 ：デフォルトの名無しさん：2021/03/03(水) 12:36:34.16 ID:+sKk2o8N.net

>>33
これは本当にそう思う

・ドキュメントはテストできない
・ドキュメントは静的解析できない

これがドキュメントの抱える最大の問題

まあ静的解析はできなくもないが
標準的なエコシステムが無いのでコストが高すぎる
独自のエクセル設計書解析システムを持ってる現場で働いたことがあるけど
解析が重すぎ&成果しょぼすぎて全く役に立ってなかった

41 ：デフォルトの名無しさん：2021/03/03(水) 13:41:07.73 ID:Lej/VXGz.net

ドキュメントもテストできるよ
自動化はまだ難しいだろうけど

42 ：デフォルトの名無しさん：2021/03/03(水) 20:42:50.69 ID:cFLgprZs.net

そもそもテストが必要になる時点でクソドキュメントだけどな。

43 ：デフォルトの名無しさん：2021/03/03(水) 21:37:51.18 ID:I2SjeTGZ.net

だから全てのドキュメントは、クソドキュメントだからテストするんだよ

44 ：デフォルトの名無しさん：2021/03/03(水) 21:54:41.54 ID:SQOFGo4F.net

ドキュメントをレビューする時に何をレビューしてんの君たちww

45 ：デフォルトの名無しさん：2021/03/03(水) 22:02:48.37 ID:I2SjeTGZ.net

ドキュメント作ってるやつがレビューをさせないんだよ
バグありのまま出来ましたって出してくる
大量に持ってくるからその場でレビューできる量じゃない
そして実際に作ってる段階で漏れや矛盾が見つかる

46 ：デフォルトの名無しさん：2021/03/03(水) 22:20:48.99 ID:R+9xzQvR.net

>>45
意味がわからん
受け取る側が勝手にレビューすればいいじゃん
その場でレビューする必要なんてないぞ

47 ：デフォルトの名無しさん：2021/03/03(水) 22:26:42.67 ID:R+9xzQvR.net

納品するやつが受け入れテストさせねーんだよ
バグありのまま出来ましたって納品してくる
そして実際に運用してる段階で不具合が見つかる


検収とか受け入れテストとかすれば良くない？

48 ：デフォルトの名無しさん：2021/03/03(水) 23:26:40.83 ID:/CRX0BjF.net

>>47
なんで御社はそんなところに発注してんの？

49 ：デフォルトの名無しさん：2021/03/04(木) 09:54:52.43 ID:OjWW0m8I.net

>>46
スケジュールの問題、遅れて遅れまくった上に
これで作れと言ってくる
レビューしてバグを戻すと、更に開発時間が減る

50 ：デフォルトの名無しさん：2021/03/04(木) 09:56:46.29 ID:OjWW0m8I.net

そもそも下流でレビューするという工程が含まれてない
上流に戻すという工程が含まれてない

51 ：デフォルトの名無しさん：2021/03/04(木) 10:38:39.26 ID:tiaJgzoo.net

>>50
工程管理に不具合があるなら修正すればいいだけじゃん
修正できないのは君の能力不足が原因

自分の能力不足を他人のせいにしてるうちは成長しない

52 ：デフォルトの名無しさん：2021/03/04(木) 11:52:45.85 ID:OjWW0m8I.net

>>51
それを修正するには、上流は偉くない、
難しいことをしてるわけじゃない、給料を減らすべきだ
という流れにつながるから上流は拒否するんだよ

53 ：デフォルトの名無しさん：2021/03/04(木) 14:56:43.77 ID:KL6FyXLz.net

>>52
それが解決策だと思うならそうすればいいじゃない

拒否されてハイそうですかって引き下がるしかできないならそれは君の能力不足
最も実際には何も行動してなくて自分の能力不足の言い訳をグチグチと垂れ流してるだけだろうけど

54 ：デフォルトの名無しさん：2021/03/04(木) 15:54:22.24 ID:iUXXoDD8.net

能力は関係ないな。契約の話だから。

55 ：デフォルトの名無しさん：2021/03/04(木) 16:13:51.36 ID:dHD8vkAI.net

そういう契約しかできないというのも能力の問題
そういう契約しかできないような会社で働く選択肢しかないというのも本人の能力の問題

問題だらけのドキュメントを提出してくるやつは
技術的能力は低くてもそれ以外の能力が及ぼす影響についていくらか理解してる分だけ
レビューさせないと愚痴るだけのやつに比べれば100倍マシ

56 ：デフォルトの名無しさん：2021/03/04(木) 16:14:25.34 ID:iUXXoDD8.net

もしかして一人で働いてるんか？
契約を開発が担当するわけないだろ

57 ：デフォルトの名無しさん：2021/03/04(木) 18:12:12.84 ID:rD8/nwrJ.net

発注側が飴対応で舐められてるのか受注側が確信犯でヤバいのかその両方なのか

58 ：デフォルトの名無しさん：2021/03/04(木) 18:28:10.38 ID:CgZMeLpz.net

>>56
理解できないんだね
君みたいな考え方しかできない開発者は例外なく使えない
例外なく、ね

59 ：デフォルトの名無しさん：2021/03/04(木) 19:32:19.14 ID:iUXXoDD8.net

>>58
使える開発者が存在するなら、俺以外がすでにやってる

60 ：デフォルトの名無しさん：2021/03/04(木) 21:06:47.63 ID:FIso/ueX.net

そりゃそんな契約しかできない会社だもん、使えるやつがいるなんて誰も思わないよww
とことん頭悪いね
問題がある現状を変えるために君は何をしたの？
愚痴ってるだけ？

61 ：デフォルトの名無しさん：2021/03/05(金) 00:44:01.22 ID:LQ4vdgyw.net

> 君は何をしたの？
転職

周りの人間を育てるよりも
すでに育っている人に変えるほうが
自分の時間を使わなくてすむ
時間は有限

62 ：デフォルトの名無しさん：2021/03/05(金) 11:13:26.36 ID:8hKplFoN.net

>>61
まともな会社に転職してたら
「ドキュメント作ってるやつがレビューをさせないんだよ」なんて言わないわなw