コンテンツにスキップ

A.2 コース番号の約束

章番号とソースディレクトリの対応マップを表示

コース保守の命名一貫性チェック図

コースのWebページは、学習者向けに第 1~13 章の表示番号で統一しています。ソースディレクトリも表示章番号に合わせてあり、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 とマルチモーダル
docs/ch13-open-source-llm第 13 章オープンソース LLM のデプロイと微調整

ページタイトル、導入文、タスク一覧、付録の説明、画像の進捗記録では、Web 表示の章番号を優先して使います。たとえば「第 5 章 機械学習」のように書きます。

入れ子になったレッスンでは、読者が今どの章・どの節にいるか分かるように、3 階層の表示番号を使います。

階層形式
開始ガイド0.K0.1 30分 AI クイック体験
章トップN4 AI 数学
任意の印刷用チェックリストN.04.0 学習ガイドとタスクシート
セクションカテゴリN.M4.1 線形代数
セクション内ページN.M.K4.1.2 ベクトル
選択モジュールE.XE.A C++ とモデルデプロイ
選択レッスンE.X.KE.A.1 C++ プログラミング基礎
付録ページA.KA.2 コース番号の約束

第 4 章の中で 1.2 のような局所番号だけを使うのは避けます。ページを直接開いた学習者には、それが 4.1 なのか、5.1 なのか、別の章なのか分かりにくくなるためです。

章トップページを主な学習ガイドにします。各トップページには、短い地図、学習順序、タスクリスト、最初に動かすコード、よくある失敗、合格チェックを置きます。N.0 ページは任意の印刷用チェックリストにとどめ、サイドバーの学習経路を重複させないでください。

記事本文の小見出しは、自然で短くします。番号は主にページタイトル、サイドバー、ナビゲーション文脈で使い、本文の小見出しに 5.1.1.1 まず地図を見る のような深い番号を付けないでください。

ファイルパス、コードスクリプト、画像ファイル名、内部リンクを参照するときは、ch05-machine-learning のようなソースディレクトリ名を使います。

旧式のフェーズディレクトリや、アルファベットの接尾辞が付いたフェーズディレクトリは、今後追加しません。章、画像、スクリプト設定を追加するときは、ch01-* から ch13-* までの番号体系を優先して使います。

1 つの文の中で両方を必ず出す必要がある場合は、次の書き方をおすすめします。

第 5 章 機械学習(ディレクトリ docs/ch05-machine-learning)

このページを終えたら、この証拠カードを残します。

参照質問
この付録ページで何を判断または明確化するために来たか
選択ルール
適用するルール、チェック項目、または説明
コースリンク
この参照が支える章またはプロジェクトはどれか
リスク確認
付録資料を意思決定の補助ではなく受動的な読み物として扱う
期待される成果
ルート、セットアップ、プロジェクト、またはレビューの判断を変えるメモ

この付録は、ページ番号、ディレクトリ名、本文見出しを混同せず、1 つの新しいページを正しい番号体系で説明できれば合格です。