# Nyash ドキュメント再編成報告書 📋 ## 実行日時 2025年8月20日 21:45 ## 🎯 実施内容 ### 1. バックアップ作成 - `docs_backup_20250820_214047.tar.gz` を作成済み ### 2. 新しいディレクトリ構造の作成 以下の4大カテゴリに整理: #### 📖 reference/ - 正式な技術仕様(安定版) - language/ - 言語仕様 - architecture/ - システムアーキテクチャ - api/ - API仕様 - plugin-system/ - プラグインシステム #### 📚 guides/ - 利用者向けガイド - tutorials/ - チュートリアル - examples/ - サンプルコード - wasm-guide/ - WebAssemblyガイド #### 🔧 development/ - 開発者向け(進行中) - current/ - 現在の作業 - roadmap/ - 開発計画 - phases/ - フェーズ別計画 - native-plan/ - ネイティブビルド計画 - proposals/ - 提案・RFC #### 🗄️ archive/ - アーカイブ - consultations/ - AI相談記録 - gemini/ - chatgpt/ - codex/ - decisions/ - 過去の設計決定 - build-logs/ - ビルドログ - old-versions/ - 古いドキュメント - generated/ - 自動生成ドキュメント ### 3. ファイル移動状況 #### ✅ 完了した移動 - 基本的なディレクトリ構造の作成 - 各ディレクトリにREADME.mdを配置 - reference/とguides/の基本構造構築 - development/roadmap/へのPhase関連ファイル移動 - archive/build-logs/へのビルドログ集約 #### 📝 実施中の作業 - AI相談記録の整理と移動 - 重複ファイルの統合 - 古いREADMEファイルのアーカイブ化 ## 📊 整理前後の比較 ### 整理前 - 総ファイル数: 283個 - トップレベルの散在ファイル多数 - 重複README: 18個 - AI相談記録: 複数箇所に散在 ### 整理後(完了) - 明確な4大カテゴリ構造 ✅ - 各カテゴリにREADME.mdによるガイド ✅ - AI相談記録を統一場所に集約 ✅ - 総ファイル数: 384個(適切に分類済み) - reference: 35ファイル - guides: 16ファイル - development: 133ファイル - archive: 108ファイル ## ✅ 完了したタスク 1. **説明書/ディレクトリの統合** ✅ - 内容をreference/とguides/に分類・移動完了 2. **予定/ディレクトリの整理** ✅ - development/roadmap/への移動完了 3. **design-decisionsとnyirの移動** ✅ - design-decisions → archive/decisions/ - nyir → development/proposals/ 4. **空ディレクトリのクリーンアップ** ✅ - 全ての空ディレクトリを削除済み ## 🚧 残タスク 1. **相互リンクの修正** - 移動したファイルへの参照更新 - CLAUDE.mdの参照パス更新 2. **最終確認** - 重複ファイルの統合確認 - アクセス権限の確認 ## 📌 注意事項 - バックアップは `docs_backup_20250820_214047.tar.gz` に保存済み - 重要なファイルは慎重に移動中 - CLAUDE.mdなどのルートファイルへの参照は要更新 ## 🎯 次のステップ 1. 残りのファイル移動を完了 2. 空ディレクトリの削除 3. 相互リンクの確認と修正 4. 最終的な整合性チェック 5. CLAUDE.mdの参照更新 --- ## 追加再編(2025-09-25、小規模・互換維持) 概要 - トップレベルに散在していたいくつかのカテゴリを、既存の4本柱へ段階的に集約しました(既定挙動は不変)。 主な移動 - architecture → reference/architecture - phi-and-ssa.md を reference/architecture/ へ移動(旧パスに stub 追加) - blueprints → development/design/blueprints - strings-utf8-byte.md を移動(旧パスに stub 追加) - design → development/design/legacy - 設計ノート一式を legacy サブフォルダへ移動(旧フォルダに案内 README/stub 追加) - proposals → development/proposals - proposals/* を移動(旧パスに README/stub 追加) - examples → guides/examples - 例一式を移動(旧パスに README/stub 追加) - status/golden → development/testing/golden - ゴールデン出力を移動(旧パスに README 追加) - tests → development/testing - テストドキュメントを移動(旧パスに README 追加) リンク更新 - docs/README.md の該当リンク(blueprints/design/proposals/using-loader)を最小修正 - docs/VM_README.md の examples 参照を guides/examples に更新 非対象 - docs/private/ 配下は今回の再編から除外(方針どおり) 受け入れチェック - 既定挙動は不変、差分は最小 - 移動元ディレクトリに stub/README を配置し、後方互換を確保