02.ナビゲーション規定

このドキュメントは、本プロジェクトにおけるドキュメントサイトのナビゲーション構造と、ドキュメント間のリンクに関する規則を定めます。

1. ナビゲーションの管理 (`mkdocs.yml`)

サイトのサイドバーナビゲーションは、リポジトリルートのmkdocs.yml内のnav:セクションで一元管理します。

手動管理 (現在):
- 新しいドキュメントを追加・削除した場合は、手動でmkdocs.ymlのnav:セクションを更新する必要があります。
- これにより、ナビゲーションの順序や階層、表示名を意図通りに制御できます。
README.mdの扱い:
- 各フォルダに配置されるREADME.mdは、主にGitHub上でのナビゲーションを目的としています。
- そのため、原則としてnav:セクションには含めません。
- ただし、カテゴリの「概要」ページとしてナビゲーションに含める場合は、この限りではありません。（例: 開発ルールカテゴリの概要ページ）
自動化 (将来構想):
- 目的: Docs/フォルダの構造をスキャンし、mkdocs.ymlのnav:セクションを自動で生成するCLIツールまたはGitHub Actionsの導入を検討します。
- 期待する効果: ドキュメントの追加・削除時にmkdocs.ymlを編集する手間がなくなり、ヒューマンエラーを防ぎます。
- 課題: ファイル名のプレフィックス（01_など）に基づいた自動ソートや、任意の表示名を設定する仕組みが必要になります。この構想は、CLIツールの仕様検討 (Issue #16)で具体化します。

ドキュメント間のリンクテキストの書式は、可読性と構造の分かりやすさのため、以下のように統一します。

ファイル名を直接指す場合:
- [05.ブランチ規定](../02_プロジェクト規定/05_ブランチ規定.md) のように、[番号.タイトル]形式で記述します。ドットの後のスペースは入れません。
- タイトル部分には、リンク先ドキュメントのH1見出しからプレフィックスを除いたものを記述します。
パスを含む場合:
- [02.プロジェクト規定/05.ブランチ規定](../../02_プロジェクト規定/05_ブランチ規定.md) のように、実際のパス構造を/で区切って表現します。これにより、リンクの階層が一目で分かります。
- または、05.ブランチ規定 のように、ファイル名を直接指す場合と同様に[番号.タイトル]形式で記述します。
要求IDを参照する場合:
- この設計は[REQ-AUTH-1.1](../../01_要求仕様/01_機能要件/01_認証機能.md#REQ-AUTH-1.1)を実現する。 のように、要求IDそのものをリンクテキストとします。詳細は 01.基本規定 を参照してください。