ドキュメントを書いて維持するのが何故こんなに大変なのか

ドキュメント書くのが面倒だっていう問題、コードを書く前に書かれるドキュメントがその目的がコードを適切に書かせるためだとすると、その後の維持メンテで必要かつ最小限の範囲からすると必ず過剰になっちゃうんだよね
コードできあがると「コード読めばいいじゃん」って部分まで残るから

— magnoliak🍧 (@magnolia_k_) 2021年11月11日

でも検討の経緯とかは残ってほしくて、でもそのためにわざわざまたドキュメントの全体構造を見直すこともできないしっていう

— magnoliak🍧 (@magnolia_k_) 2021年11月11日

コードの複雑さを分かりやすく要約して理解しやすくする為にドキュメントを書くんだからコード以上に難しくなるのは当たり前なんだよね

経緯も書いたら時系列が必要になるし

扱ってる領域が広さ的にも時間軸的にも違うんだよなーって思った

— magnoliak🍧 (@magnolia_k_) 2021年11月11日

この辺で手を打ってもらえないかって話になるよね

正直、ノーコード開発とかより、コード書いたらいい感じの図が自動的に出力されてくれる方が256倍ぐらい嬉しい。

— アルフォートおじさん (@joker1007) 2021年11月11日

ドキュメントはステークホルダーとのコミュニケーションツールなのに、そのコミュニケーション設計が無いまま「こうあるべき」という議論をしても「オレオレ絶対正しい理論」が誕生するだけだよね。誰が読んでも分かる表現なんて無いわけで。