開発プロジェクトに新しく加わった時は、まずプロジェクトの理解が第一。しかし、全体像を把握できるようなドキュメントがなく、コードから断片的な情報をかき集めるしかない場合もあります。新参の開発者がスムーズにプロジェクトを理解できるよう、大規模なプロジェクトでは「プロジェクト全体のアーキテクチャ」を示した「ARCHITECTURE.md」を添えた方がよいと、エンジニアのAleksey Kladov氏が指摘しています。 ARCHITECTURE.md https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html Kladov氏はオープンソースプロジェクトの開発に携わる中で、「プロジェクトのアーキテクチャに対する知識量」によって開発スピードに大きな差が生じると気づいたとのこと。アーキテクチャに関する知識がない開発者にとって、大量のコードは「バラ
![プログラムの「アーキテクチャに関するドキュメント」は面倒でも書くべき、ではどのように書くべきか?](https://cdn-ak-scissors.b.st-hatena.com/image/square/7693f4f081eb848e06674a9035fe52d1f98065f6/height=288;version=1;width=512/https%3A%2F%2Fi.gzn.jp%2Fimg%2F2021%2F02%2F10%2Farchitecture-md%2F00.jpg)