{{書名}} ソースコードマッピング
プロジェクト情報
| 属性 | 値 |
|---|---|
| プロジェクト名 | {{プロジェクト名}} |
| バージョン/Commit | {{バージョン番号またはコミットハッシュ}} |
| リポジトリURL | {{リポジトリURL}} |
| 主要言語 | {{プログラミング言語}} |
| 総ファイル数 | {{約N個}} |
| 本書でカバーするファイル数 | {{約N個}} |
プロジェクトディレクトリ概要
{{プロジェクト名}}/
├── {{ディレクトリ1}}/ # {{用途の説明、例:「コアソースコード」}}
│ ├── {{サブディレクトリ1}}/ # {{用途の説明}}
│ └── {{サブディレクトリ2}}/ # {{用途の説明}}
├── {{ディレクトリ2}}/ # {{用途の説明、例:「テストファイル」}}
├── {{ディレクトリ3}}/ # {{用途の説明、例:「設定ファイル」}}
├── {{エントリーファイル}} # {{用途の説明、例:「プロジェクトエントリー」}}
└── {{設定ファイル}} # {{用途の説明、例:「パッケージ管理設定」}}ソースコードマッピング表
第一部: {{パートタイトル}}
{{このパートが解決する問題と、プロジェクトのどの側面をカバーするか}}
第1章: {{章タイトル}}
| ソースコードパス | コアファイル | 重要度 | 備考 |
|---|---|---|---|
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | 高 | {{重点を置く関数/クラス}} |
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | 中 | {{着眼点}} |
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | 低 | {{背景知識として言及のみ}} |
第2章: {{章タイトル}}
| ソースコードパス | コアファイル | 重要度 | 備考 |
|---|---|---|---|
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | {{高/中/低}} | {{備考}} |
第二部: {{パートタイトル}}
{{このパートが解決する問題}}
第3章: {{章タイトル}}
| ソースコードパス | コアファイル | 重要度 | 備考 |
|---|---|---|---|
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | {{高/中/低}} | {{備考}} |
第4章: {{章タイトル}}
| ソースコードパス | コアファイル | 重要度 | 備考 |
|---|---|---|---|
| {{ディレクトリ/ファイルパス}} | {{具体的なファイル名}} | {{高/中/低}} | {{備考}} |
第三部: {{パートタイトル}}
{{このパートが解決する問題}}
カバーしないファイルリスト
| ファイル/ディレクトリ | カバーしない理由 |
|---|---|
| {{パス}} | {{理由、例:「テストファイル、本書の範囲外」}} |
| {{パス}} | {{理由、例:「ビルド設定、コアロジックと無関係」}} |
| {{パス}} | {{理由、例:「廃止済みの互換レイヤー」}} |
章横断で共有されるファイル
| ファイル | 参照章 | 各章での着眼点 |
|---|---|---|
| {{ファイルパス}} | ch{{A}}, ch{{B}} | ch{{A}}: {{着眼点A}}; ch{{B}}: {{着眼点B}} |
コード量の統計
| 章 | カバーファイル数 | 総コード行数(約) | コア行数(約) |
|---|---|---|---|
| ch01 | {{N}} | {{N}} | {{N}} |
| ch02 | {{N}} | {{N}} | {{N}} |