プロダクト開発でドキュメントを書かないとどうなるか

Agile Manifestoには以下のように書いてあります。 動作するソフトウエアは包括的なドキュメントにまさる ともするとドキュメント軽視と取られかねない宣言です。この宣言を誤って解釈してドキュメントはいらないとなる場合もあるかもしれませんが筆者はそれは間違いだと思っています。この宣言では包括的なドキュメントよ

[chinpokomon_master]

問題を間違えている。PMFしてからの問題はPMFしない事に比べたら大したことないのでドキュメント書かなくていいからとっととPMFする事が大事。ドキュメントがない苦労はPMFしてからすればいい。典型的な誤謬。

[tetsu23]

そのグラフはちょっと違うかと。ドキュメントを書くぶん、最初の立ち上がりは遅くなるはず。ドキュメントを書くのは大切だとは思うんだけど、それを工数に入れずに書けっていうこと多くて困る。

[UKIBORI]

これは凄い試みだなぁ “チャットの履歴を一定期間しか残さない GitLabはLet your Slack or chat messages expire quicklyとし、チャットのメッセージを一定期間しか残さないようにしています。”

[deztecjp]

グラフの縦軸が「開発効率」なの、全く納得できない。「効率」が一直線に上がるわけがないし、最初がゼロなのも奇妙。「大規模化に伴う効率の低下を補う」くらいの感覚。「成果物の産出量」なら、まだわかる。

[morimarii]

まずドキュメントを含めてプロダクトだと定義するところからでないの/誰のどういう要求からどのような仕様になったかってのか大事なんですわ

[kako-jun]

対数グラフと似てるけど、tが小さいときに、指数関数っぽい上向きカーブになってるところが細かくて、体感と一致してるわ。まるでドキュメントが無いほうが、どんどん効率が上がってくかのように錯覚するの

[raamen07]

ぶっちゃけテストもドキュメントも書いても書いても開発が継続するとバグは無くならないしよく分かんない仕様は存在し続けるんだよな。作った奴がさっさと辞めるのを止める方がいいと思う。

[stefafafan]

アジャイルソフトウェア開発宣言に関しては "左記のことがらに価値があることを 認めながらも、私たちは右記のことがらにより価値をおく" の部分も強調したい感

[maketexlsr]

ドキュメント書く能力とコード書く(その他)の能力は別だからなー。脳内のメモリの状態を文章以外の方法でスナップショット取る方法があれば…。(これ、AIの説明可能性と地続きだったりしないかな？)

[carrier_pigeon]

「開発する上で書く必要のあるドキュメントの種類を明確にする」だよなぁ。SIerの要求する文書の粒度細かすぎ。設定ファイルとかはIoCでよい。ただし何をどう設定できるのかという仕様や判断理由は必要。

[ofsilvers]

チャット履歴を一定期間しか残さないのいいな

[YOSHIOKA_Ko57]

“Single Source Of Truth”

[masutaka26]

これはめっちゃいいな。議事録も Slack にあるのはキツイんだよな 🌀 "GitLabはLet your Slack or chat messages expire quicklyとし、チャットのメッセージを一定期間しか残さないようにしています"

[rararoro-ryo]

最近はADRの有効性を言う人が多いけどなぁ。

[takezaki]

“プロダクトが無事PMFをはたし会社も人が増えてきました。そのような状況になるとドキュメントがないことによる弊害が見え始めます。”

[peller]

Requirement(要求)・Specification(仕様)は純ドキュメント必要。でも実装に関わることはコードがドキュメントだよ。

[dorokei]

時間経過とともに開発効率が「上がって」いるだと、、

[GEROMAX]

必要なものを必要なだけ作るだけさ

[kagerou_ts]

PMFまでは目をつぶるとしてもそれ以降も書かれないからご覧の有様なんでしょ。これを解決する方法は古来よりひとつしかない。ドキュメント書く人/時間を割り当てる。決定権を持ってる人間が理解しないと無理。

[raimon49]

GitLabのチャットメッセージに期限付けるやつ、よく話題になるけど相当にハードコアなルールだよなぁ。逆に言えば、それくらい振り切らないと人はドキュメントを書かないのか。

[u_1roh]

スター集めてるブコメひどくない？PMFした後はドキュメント書いた方がいいよって書いてあるじゃん。読まずにコメントしてるのかな…

[securecat]

“トップダウンでドキュメントが必須だと明確にチームに伝える”←これ、ゆってるだけで工数見積の精度高める努力してない場合ありそうな？　ドキュメントの妥当性検証の時間とか含め。

[toaruR]

正確なドキュメントならなー＼(^o^)／

[ledsun]

“トップダウンでドキュメントが必須だと明確にチームに伝える” ドキュメントを書くことも仕事だって明示しないといけない

[shiba_yu36]

、

[strawberryhunter]

「昔からいる人のタスクは分割され新しい人に割り振られます。そのとき新しい人にどのように仕様を伝えるのでしょうか。そうです、ドキュメントです。」用途はそれだけなの？費用対効果に合うのかなあ。

[fjwr38]

ドキュメントを書いたことを忘れるということは度々発生すると思うんだ

[shioki]

“少人数のときはいいのですが、大人数になると目に見えてドキュメントがないことへの弊害がみえてきます”

[shophonpo8]

ドキュメントがないと、設計者の能力不足に気づくの遅れやすい。他人の仕事の未熟さは関係ないのでなく、自分に影響ある箇所に未熟なやつがいるとこっちにも影響でるし、そこがブラックボックス化になりやすく危ない

[kat21]

バランス問題なのは間違いないが、人数が増えたらドキュメント化は必要。誰が、なんのために読むか、という観点で残すのがいいね。

[hiromi_ayase]

言いたいことの本筋ではないと理解した上でいわせてもらうが、ドキュメントがあるからって人が増えれば線形に開発効率が上がるかのような表現はやめるんだｗｗｗｗ

[nakag0711]

説明書的なものと仕様書的なものがあるが…説明書がない機能はユーザにとってないのと同じ。直観的に使えると思ってるのは往々にして作った本人だけ。仕様書がない機能はテストできないのと同じ

[baronhorse]

ドキュメンテーションは難しいんだよな。製品／テストコードより時間かかることとかざらにある

[nishi1231chang]

いや、トップブコメはPMFに達するまでに極少人数の開発でできる前提だが、そうとは限らない。あと、数人以上になるとドキュメント無しではすでに少しづつコミュニケーションコストも上がり、生産性が落ち始める。

[pmint]

クソグラフから始まるプロジェクト管理論。人員数を2倍にすれば効率も2倍になるクソグラフ。

[MERCY]

これ自体には特に異論は無いけど、嘘を書いたドキュメント(古い情報も含む)が混じってる位なら、全く無い方がまだマシ

[SWIMATH2]

slackの保存期間短くするのエクストリームドキュメンテーションという感じしておもろいな

[for-my-internet-demo]

最近こんな話題ばっかりで引き継ぎフェーズの会社が多くなったんやな。OSS でも初学者がコピペで雰囲気わかるような綺麗なdoc出てきたの実は意外に最近の話ってイメージですわ