40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
|
# Docs Reorganization Plan (P2.x)
|
|||
|
|
|
|||
|
|
目的: ルート直下に散在する Markdown を `docs/` 配下に集約し、カテゴリ別に検索しやすくする。実ファイルの削除・復元はせず、移動方針とマッピングを明示する。
|
|||
|
|
|
|||
|
|
## 方針
|
|||
|
|
- ルートには README/AGENTS/ビルド・ラン入口のみを残し、それ以外は `docs/` に移す。
|
|||
|
|
- 既存の削除/改変は触らない（ユーザー作業を壊さない）。
|
|||
|
|
- 最新・有用な文書だけを `analysis/design/status/benchmarks/specs/roadmap` に残し、古いものは `docs/archive/` へ。
|
|||
|
|
- インデックスは `docs/INDEX.md` をエントリーポイントにする。
|
|||
|
|
|
|||
|
|
## カテゴリ
|
|||
|
|
- analysis/ — 調査・RCA・ベンチ結果
|
|||
|
|
- design/ — 仕様・設計・アーキテクチャ
|
|||
|
|
- benchmarks/ — ベンチ手順・結果
|
|||
|
|
- status/ — 進捗・フェーズまとめ
|
|||
|
|
- roadmap/ — 今後の方針/優先順位
|
|||
|
|
- specs/ — ENV・BUILD 等のリファレンス
|
|||
|
|
- archive/ — 旧版/履歴/退避
|
|||
|
|
|
|||
|
|
## 移動ガイド（パターン）
|
|||
|
|
- `*_REPORT.md`, `*_ANALYSIS.md`, `ROOT_CAUSE*.md` → `docs/analysis/` または `docs/archive/analysis/`
|
|||
|
|
- `*_PLAN.md`, `*_DESIGN.md`, `SPEC*.md` → `docs/design/` または `docs/specs/`
|
|||
|
|
- `*_STATUS.md`, `*_SUMMARY.md`, `PHASE*_*.md` → `docs/status/`
|
|||
|
|
- ベンチ結果・手順 (`BENCH*`, `PERF*`, `LARSON*`, `RANDOM_MIXED*`) → `docs/benchmarks/`
|
|||
|
|
- 古い/不要なもの → `docs/archive/`（サブフォルダは任意: analysis, design, status など）
|
|||
|
|
|
|||
|
|
## ルートに残すもの
|
|||
|
|
- README.md（概要）
|
|||
|
|
- AGENTS.md（箱理論・協働ルール）
|
|||
|
|
- build/run 系の入口（build.sh, run_* scripts など）
|
|||
|
|
- DOCS_REORG_PLAN.md（本ファイル）
|
|||
|
|
|
|||
|
|
## 次のステップ（最小）
|
|||
|
|
1) ルート直下の *.md を上記パターンに沿って一括移動（mv/rename）。古いものは archive へ。
|
|||
|
|
2) `docs/INDEX.md` に主要ファイルだけリンクする（全部は貼らない）。
|
|||
|
|
3) `README.md` に「詳細は docs/INDEX.md を参照」と一文を追記。
|
|||
|
|
4) 移動後にリンクチェック（必要なら sed で修正）。
|
|||
|
|
|
|||
|
|
備考: 大量の D 状態のファイルはユーザー作業を尊重し、復元しない。移動は現存ファイルのみ対象。
|