プログラムの「アーキテクチャに関するドキュメント」は面倒でも書くべき、ではどのように書くべきか?


開発プロジェクトに新しく加わった時は、まずプロジェクトの理解が第一。

しかし、全体像を把握できるようなドキュメントがなく、コードから断片的な情報をかき集めるしかない場合もあります。

新参の開発者がスムーズにプロジェクトを理解できるよう、大規模なプロジェクトでは「プロジェクト全体のアーキテクチャ」を示した「ARCHITECTURE.md」を添えた方がよいと、エンジニアのAleksey Kladov氏が指摘しています。

続き…