コードベースを理解していないことへの擁護
In defense of not understanding your codebase (seangoedecke.com)
要約
この記事は、ソフトウェアエンジニアが自身のコードベース全体を完全に理解する必要はないという考え方を擁護しています。特に大規模システムやチームの入れ替わりが激しい環境では、部分的な理解で効果的に作業を進めることが可能であり、むしろそれが現実的なアプローチであると論じています。Peter Naurの「プログラミングは理論構築である」という考え方に対し、現代の巨大なコードベースでは完全な理論構築は不可能であり、部分的な理解に基づいた実践が重要であると主張しています。
全文翻訳
コードベースを理解していないことへの擁護
ソフトウェアエンジニアとして、あなたは自分のコードベースをどの程度理解する必要がありますか?
小規模なコードベースで、離職率の低いチーム(例えばRedisやThe Witnessのようなゲーム)で働く人々は、「もちろん完全に理解する必要がある、そうでなければ良い仕事はできない」と言うでしょう。また、大規模なコードベースで離職率の高いチーム(例えばGoogleのウェブ検索バックエンドやGitHub)で働く人々は、「もちろん完全に理解することは不可能だ、自分の担当範囲で最善を尽くすしかない」と言うでしょう。
これらは、異なる方法論、プラクティス、文化を持つ、大きく異なる2つのプログラミングのあり方です[1]。しかし、オンラインでのソフトウェアエンジニアリングに関する議論では、前者のグループが過剰に代表されています[2]。私は、後者のグループを前者のグループに対して擁護したいと思います。多くのソフトウェアエンジニアリング環境では、部分的な理解の状態にあることに何ら問題はありません。実際、大規模システムにおいては、部分的な理解が最善の策なのです。
「プログラミングは理論構築である」に反対する
「コードベースを理解する必要がある」という側の最も優れた論証は、Peter Naurの有名な論文『Programming as Theory Building』です。私はこの論文を気に入っていますが、この方向性で行き過ぎだと考えています。Naurの核心的な主張は、プログラマーがプログラムに取り組むとき、コードは単なる副産物であり、彼らが取り組んでいる主な成果物は「プログラムの理論」であるということです。これは、何が起こっていてなぜそうなるのかについての直感的な感覚で構成されており、コードやドキュメントでは部分的にしか捉えられません。もしコードを失ったとしても、プログラムを簡単に書き直すことができるはずです。もし彼らの理解(例えば、チームの離職率が100%だった場合)を失ったなら、コードを理解するのに苦労するでしょう。
ここまでは良いのですが、Naurはさらに進みます。彼は、理論はコードから再構築されるべきではないと言います。Naurによれば、プログラム全体を破棄して、新しいチームにゼロから再構築させる方が良い、その過程で新しい理論を構築するのです[3]:
ドキュメントから単にプログラムの理論を再確立することは、厳密には不可能である…したがって、既存のプログラムテキストは破棄され、新しく編成されたプログラマーチームは、この問題に改めて取り組む機会を与えられるべきである。
大企業で効果的なソフトウェアエンジニアだった経験のある人なら誰でも、Naurはこの点に関して完全に間違っていることを知っています。少なくとも2つの理由があります。
第一に、大規模なソフトウェアシステムをゼロから再構築することは単純に不可能です。十分に大規模なシステム(ユーザーがいる場合)には、再実装できない何千もの奇妙なケースや癖が含まれています。システムを深く理解しているチームでさえ、それを実行することはできません。あまりにも多くのものを同時に扱う必要があります。成功した書き換えは、常に既存のコードベースを小さく分離されたチャンクに切り出し、一度に1つのチャンクを書き換えることから始まります。つまり、ソフトウェアシステムを書き換えるということは、古いシステムに多くの変更を加えることを意味します。古いシステムを変更できないのであれば、新しいシステムでそれを置き換えることは間違いなくできません。
第二に、放棄されたシステムは常に復活します。何億行ものコードと何千人ものエンジニアがいるテクノロジー企業では、コードベースに精通した人が誰もいなくなることは珍しくありません[4]。数人が不適切な時期に辞めるか、コードベースが1年間メンテナンスされないだけで済みます。私は他のチームがこれを行うのを見たことがあるだけでなく、私自身も放棄されたコードベースを引き継ぎ、それを理解し、効果的に作業できるようになるまでになりました。時間がかかりますが、コードベースの新しい理論を構築することは可能です。まず1つのフローをエンドツーエンドで理解することから始め、そこから徐々に広げ、注意深く変更を加えていきます。
十分に大規模なコードベースでは、誰もが不正確なプログラム理論を持って作業しています。現代のソフトウェアシステムの定義的な特徴は、誰か(あるいはチーム全体)がそれをすべて頭に入れておくには大きすぎるということです。誰もがそれをすべて理解しているわけではありません。効果的であるためには、部分的に正しい理論で作業する方法を見つけなければなりません。だからこそ、私は立場を取ることや自信について繰り返し話すのです。何かが不確かでも、完璧な理解を持つ誰かが来て答えを与えてくれるのをただ待つことはできません。あなたが有能なエンジニアであれば、その人物はあなた自身です。歯を食いしばり、最も教育的な推測をして、その結果に対処しなければなりません。
Naurに寛大に言えば、1985年頃のプログラムの平均サイズは今日より数桁小さかった可能性があり、Naurが「大規模プログラム」について書くとき、それは数千万行のコードのことではないかもしれません。Naurの最初の大規模プログラムの例は20万行の産業監視プログラムであり、2番目の例はコンパイラです。1987年、GCCの最初のバージョンは約10万行でしたが、2015年にはGCCは1400万行を超えました。10万〜20万行のコードを書き換えるのは比較的簡単だと信じられますが、特に既存のテストを再利用できる場合はなおさらです。100万〜200万行ではそうはいきません。
理論構築は多くのトレードオフの一つ
LLMは、通常の理論構築プロセスを妨げるため、悪いツールとしてしばしば引用されます。これはあまりにも単純化しすぎていると思います。多くのソフトウェアツールと同様に、LLMは諸刃の剣です。ソフトウェアの詳細なメンタルモデルを構築することをより困難にしますが、部分的な理論を迅速に構築することを可能にし、その部分的な理論をより効果的に活用するのに役立ちます。これは私がまだ考えている複雑なトレードオフです。
LLMはさておき、ソフトウェアに対するあなたの理論の構築を妨げるものはすべて悪いと言うのは愚かだと確信しています。理論の維持をより困難にする他のものの部分的なリストを以下に示します:
- 他の人があなたのコードベースにコードを書くことを許可すること
- アクセシビリティやデータ保護のような法的に要求される機能を実装しなければならないこと
- 同僚が仕事を辞めたり、チーム間を移動したりすることを許可すること
- セキュリティパッチのためにソフトウェアバージョンをアップグレードしなければならないこと
- ライブラリやその他の依存関係を持ち込むこと
ソフトウェアのほとんどのことと同様に、「コードベースの理論を維持すること」は多くの価値観のうちの一つです。時にはそれが最も重要な価値観であり、他の価値観を犠牲にしてそれを優先しますが、時にはスピード、法的コンプライアンス、または政治的な理由のためにそれをトレードオフします[5]。
ほとんどすべてのエンジニア、特に「純粋な」エンジニアは、ソフトウェアの正確なメンタルモデルを維持することを好みます。それはより楽しく、ストレスが少なく、「本物のエンジニアリング」のように感じられます。だからこそ、多くのエンジニアが、コードベースの正確なNaur理論を維持できるエンジニアリング作業を行うために、余暇にオープンソースプロジェクトに取り組むのです。それ自体に問題はないと思います。
しかし、職場では仕事のために給料をもらっています。言い換えれば、彼らは彼らのエンジニアリング価値観を採用するためにお金を払っています。パフォーマンスについて個人的にどれだけ気にかけていても、時には職場で遅いコードを書かなければならない(例えば、プロジェクトを時間通りに完了するため、または厄介な要件に対応するため)ことは、おそらくよく理解されているでしょう。コードベースの理論を維持することも、同じようなことです。
編集:この投稿はlobste.rsでいくつかのコメントを得ました。興味深いコメントは、コードについて「局所的に」推論する能力(つまり、部分的な理解で)が、CSの始まりからの中心的な目標であったことを指摘しています。これは私が『How good engineers write bad code at big companies』で述べようとしていたことをよく表しています。また、この投稿がLLMに関する1つのくだけた段落のためにvibecodingとしてタグ付けされたのは面白いです。それでも、この投稿をブログでAIとしてタグ付けするつもりはありません、すみません。
編集:Hacker Newsでもコメントがありました。トップコメントは、私がよく受けるコメントのジャンルで、基本的に「待てよ、この状況はひどい!なぜこのブログ記事はこのひどさについて書かれていないんだ?」というものです。まあ、そのような投稿はすでにたくさんあります。私は別のニッチを埋めたいと思っています。別のコメントは、私をSeth Godinと比較する2番目の(痛い)コメントです:
GoedeckeはSeth Godinのような無害なサウンドバイトほどではないが、エンジニアリングに役立つものは何も書かず、テックリードやラインマネージャーが話していることについて、なんとなく知りたい人向けの語彙解説を書いているだけだ。
第一に、これはHacker Newsで人気のある投稿の種類(つまり、私の技術エンジニアリングトピック や 投稿 ではなく 、 、)によって偏っています。第二に、「テックリードやラインマネージャーが話していることを知りたい」ということは非常に重要だと思います!
この投稿はTwitterでも注目を集め、いくつかの長い 引用ツイートが含まれていました。私は特にこの「コードベースの理論」は時間的な理論である可能性があるという考えを気に入っています。つまり、「なぜ私たちはこの時点でXを構築したのか」「Yはいつ導入されたのか」などを答えられるということです。
編集:Jani Hartikainenによるこのブログ記事の応答も推奨します。彼は、理論理解を他の価値観とトレードオフできないと述べていますが、私はそれに同意しません。なぜなら、それらの他の価値観は理論の一部を形成するからです。「プログラムの理論をシンプルに保つ」ということは、プログラムに複雑さを加えるたびに(例えば、顧客のリクエストを満たすために)トレードオフされる首尾一貫した価値観だと思います。
編集:Theoは、この投稿についてYouTube動画を作成しました。約14分30秒のところで、彼はTwitchの同僚の例を挙げています。その同僚は非常に優秀なエンジニアでしたが、GraphQLクエリを設定してフロントエンドから呼び出す方法についての具体的なコンテキストがなく、苦労していました。これはまさに私が言いたいことです。どれだけ優秀であっても、コードベースのあまり馴染みのない部分で作業するときは苦労するものです。念のため、私は「コードベースを理解しているなら、それは重要ではないほど小さい」という彼のTwitterでの表現を支持しません。非常に小さいコードベースでも、多くのものが重要です。
-
私は『Pure and impure software engineering』でこの点について詳しく書きました。ソフトウェア業界で繰り返される多くの議論は、純粋な完全理解文化が不純な部分的理解文化と衝突することによって引き起こされていると思います。
-
オープンソースエンジニアは、自分の仕事についてブログを書くことに熱心であり、生のエンジニアリングコンテンツは通常より印象的です(調整の問題が大規模な独自システムを支配するため)、オープンソースプロジェクトは合法的に書くことができますが、独自システムはできません。そして、合法的にできたとしても、大規模なコードベースについて書くことは、あまりにも多くの特定のコンテキストを必要とするため不可能です。
-
私は、Naurが全体で引用しているRyleの『The Concept of Mind』の関連章を再読しましたが、Ryleは理論構築についてより寛容だと思います。Ryleにとって、理論構築やノウハウは、物事を行うにつれて自動的に起こります。コードから既存のコードベースを、単にそれを解き明かすことによって拾い上げることができると考えることは、Ryleと完全に一致しています。
-
Naurは次のように述べています。「この結果が不当に思えるかもしれないので、完全に死んだプログラムの復活の必要性はめったに生じないだろうと指摘してもよい。なぜなら、復活が元のチームが持っていた理論についての知識なしに新しいプログラマーに割り当てられるとは想像しがたいからだ。」もしそうなら!
-
一部のエンジニアは、理論の維持が中核価値であると言うかもしれません。なぜなら、それがなければ他のどの価値も満たすことができないからです。私は同意しません。可読性、保守性、正確性、または他の多くのエンジニアリング価値観についても同じことが言えます。私たちは、このような「中核」価値観を常にトレードオフしています。
これは、この投稿と同じタグを持つ関連投稿のプレビューです。