A.2 コース番号の約束
コースを保守するときは、Web タイトル、sidebar の順番、ソースディレクトリ、画像の命名を互いにそろえる必要があります。図を見るときは、「表示番号」と「ファイルパス」を分けて見ると、chxx と中国語の章番号が混ざる問題が起きにくくなります。
コースのWebページは、学習者向けに第 1～12 章の表示番号で統一しています。ソースディレクトリも表示章番号に合わせてあり、ch01-* は第 1 章、ch02-* は第 2 章、以下同様です。
ディレクトリ名の後半はテーマを表します。たとえば、ch05-machine-learning は第 5 章の機械学習、ch09-agent は第 9 章の AI Agent を意味します。sidebar の「主線 1～4」は学習グループであり、ファイルディレクトリの階層ではありません。
対応関係
| ソースディレクトリ | Web 表示章 | コース名 |
|---|---|---|
docs/ch01-tools | 第 1 章 | 開発者ツール基礎 |
docs/ch02-python | 第 2 章 | Python プログラミング基礎 |
docs/ch03-data-analysis | 第 3 章 | データ分析と可視化 |
docs/ch04-ai-math | 第 4 章 | AI 数学の最小限の基礎 |
docs/ch05-machine-learning | 第 5 章 | 機械学習の入門から実践まで |
docs/ch06-deep-learning | 第 6 章 | 深層学習と Transformer の基礎 |
docs/ch07-llm-principles | 第 7 章 | 大規模モデルの原理、Prompt とファインチューニング |
docs/ch08-rag | 第 8 章 | LLM アプリ開発と RAG |
docs/ch09-agent | 第 9 章 | AI Agent とインテリジェントエージェントシステム |
docs/ch10-computer-vision | 第 10 章 | コンピュータービジョン |
docs/ch11-nlp | 第 11 章 | 自然言語処理 |
docs/ch12-multimodal | 第 12 章 | AIGC とマルチモーダル |
執筆ルール
ページタイトル、導入文、タスク一覧、付録の説明、画像の進捗記録では、Web 表示の章番号を優先して使います。たとえば「第 5 章 機械学習」のように書きます。
入れ子になったレッスンでは、読者が今どの章・どの節にいるか分かるように、3 階層の表示番号を使います。
| 階層 | 形式 | 例 |
|---|---|---|
| 開始ガイド | 0.K | 0.1 30分 AI クイック体験 |
| 章トップ | N | 4 AI 数学 |
| 任意の印刷用チェックリスト | N.0 | 4.0 学習ガイドとタスクシート |
| セクションカテゴリ | N.M | 4.1 線形代数 |
| セクション内ページ | N.M.K | 4.1.2 ベクトル |
| 選択モジュール | E.X | E.A C++ とモデルデプロイ |
| 選択レッスン | E.X.K | E.A.1 C++ プログラミング基礎 |
| 付録ページ | A.K | A.2 コース番号の約束 |
第 4 章の中で 1.2 のような局所番号だけを使うのは避けます。ページを直接開いた学習者には、それが 4.1 なのか、5.1 なのか、別の章なのか分かりにくくなるためです。
章トップページを主な学習ガイドにします。各トップページには、短い地図、学習順序、タスクリスト、最初に動かすコード、よくある失敗、合格チェックを置きます。N.0 ページは任意の印刷用チェックリストにとどめ、サイドバーの学習経路を重複させないでください。
記事本文の小見出しは、自然で短くします。番号は主にページタイトル、サイドバー、ナビゲーション文脈で使い、本文の小見出しに 5.1.1.1 まず地図を見る のような深い番号を付けないでください。
ファイルパス、コードスクリプト、画像ファイル名、内部リンクを参照するときは、ch05-machine-learning のようなソースディレクトリ名を使います。
旧式のフェーズディレクトリや、アルファベットの接尾辞が付いたフェーズディレクトリは、今後追加しません。章、画像、スクリプト設定を追加するときは、ch01-* から ch12-* までの番号体系を優先して使います。
1 つの文の中で両方を必ず出す必要がある場合は、次の書き方をおすすめします。
第 5 章 機械学習（ディレクトリ docs/ch05-machine-learning）