coding-style - コード ドキュメント アーキテクチャの書き方

Question

私は新しいプロジェクトに移ったので、コード全体を説明するドキュメントを書くことを期待されています。新しい開発者がプロ​​ジェクトに参加した場合、ドキュメントを見てコードを理解できるようにするためです。コードは C で書かれています。ドキュメントの技術的な名前 (設計ドキュメントを作成しているわけではありませんよね?) と、ドキュメントの開始方法を教えてください。

前もって感謝します

Answer 1

通常、これを「テクニカル デザイン」と呼びます。ただし、通常は、「機能仕様」、「高レベル設計」、「低レベル設計」などの複数のドキュメントに分割します (これらを合わせて技術設計を構成します)。しかし、それはもちろん、あなたが働いている組織によって異なります。