NexusCore ドキュメント全体インデックス
NexusCore プロジェクトのドキュメント全体マップ
このファイルは、
docs/ディレクトリ配下のすべてのドキュメントへのナビゲーションを提供します。 特定のカテゴリのローカルインデックス(例:HANDOVER_INDEX.md)がある場合は、そちらも参照してください。
📚 役割別ナビゲーション
🆕 新規開発者向け
セットアップから開発フローまで
- 開発環境セットアップ - 開発環境の構築方法
- README_VENV.md - 仮想環境の簡単な使い方
- Makefile ガイド - Makefile の使い方
- テスト戦略 - テストの考え方と実装方針
- テスト実行ガイド - テストの実行方法
関連ドキュメント:
- atelier-kyo-manager 統合 - 外部プロジェクトとの統合
- WSL セットアップガイド - WSL 環境のセットアップ(PDF)
🚀 運用担当者向け
Kubernetes、SaaS、通知設定
Kubernetes / インフラ
- Kubernetes クイックスタートガイド - 初心者向け K8s セットアップ
- K8s 接続ガイド - クラスターへの接続方法
- K8s ワーカースケーリングガイド - ワーカーのスケーリング
- K8s セットアップ状況 - 現在のセットアップ状況
- K8s 実装サマリー - 実装内容のまとめ
- K8s 次のステップ - 今後の展開
SaaS / 運用
- SaaS アーキテクチャ - SaaS MVP の全体設計
- SaaS MVP セットアップ - MVP のセットアップ手順
- SaaS MVP 実装サマリー - 実装内容のまとめ
- SaaS バッジ設定 - バッジの設定方法
- Celery セットアップ - Celery の設定
Slack / 通知
- Slack Webhook URL 設定 - Webhook URL の取得方法
- Slack 通知セットアップ - 通知機能の設定
- Slack 通知トラブルシューティング - 問題解決ガイド
🏢 経営 / 監査向け
アーキテクチャ分析と監査レポート
- エンタープライズアーキテクチャ分析レポート - 全体アーキテクチャの分析
- 開発者スキル監査レポート - 開発者スキルの評価
- デューデリジェンス監査レポート - デューデリジェンス結果
🤖 AI / Cursor 向け
AI 開発支援ツール向けの指示とプレイブック
- NexusCore コードレビュー対応 Playbook - CR対応のテンプレートと手順
- Codex 指示マニフェスト - Codex への指示事項
- Cursor 設定クイックガイド - Cursor の設定方法
- Cursor チャット同期場所 - チャット同期の設定
- Cursor モバイルチャット同期 - モバイルでの同期
📁 カテゴリ別ドキュメント一覧
ハンドオーバー系
開発作業の申し送り資料
注意: ハンドオーバー関連の詳細は HANDOVER_INDEX.md を参照してください。
- HANDOVER_INDEX.md - ハンドオーバー資料のインデックス
- HANDOVER_QUICK_REFERENCE.md - クイックリファレンス
- handover_checklist.md - チェックリスト
- handover_report.md - 完全版レポート
- handover_summary.md - 簡易サマリー
仕様・CR・完了レポート系
Spec(仕様)・Change Request・完了レポートの保存先とルール
- CR と実装計画の結果の保存先 - Spec / 完了レポートの保存場所、完了レポートに含める項目、テスト必須ルール
- STIT(Spec & Test Driven Iteration): 仕様・テスト・実装の順序と Gate は ガバナンス/スペックテスト駆動イテレーション.md を参照
- Phase 3(IRG): docs/ARCHITECTURE.md および ガバナンス/templates/レビューパケット_フェーズ3_テンプレート.md を参照
テスト戦略・結果系
テストの設計、実行、結果レポート
- テスト戦略設計書 - テスト戦略の全体設計
- テストガイド - テストの実装ガイド
- Phase3 テスト戦略 - Phase3 のテスト方針
- UI テストポリシー - UI テストのポリシー
- テスト実行ガイド - テストの実行方法
- テスト結果レポート - テスト結果のレポート方法
- E2E テストガイド - E2E テストのガイド
- Self-Healing E2E テストガイド - Self-Healing の E2E テスト
- E2E テスト結果 - E2E テストの結果
機能別テスト結果:
NexusCore 実装詳細系
機能実装の詳細ドキュメント
- JobStateMachine 実装 - ジョブ状態遷移の実装
- Tree-sitter チェッカー最適化 - Tree-sitter の最適化
- 外部 API 検証 - 外部 API の検証方法
- 外部 Run API 例 - 外部から Run API を呼び出す例
- Run レポートポリシー - Run レポートの保存ポリシー
- ログ履歴管理検証 - ログ履歴管理の検証
- Semantic Diff 設計 - Semantic Diff の設計
- Phase3 カバレッジサマリー - Phase3 のカバレッジ状況
📊 生成物ディレクトリ
以下のディレクトリには、自動生成されるレポートが保存されます。編集は行わないでください。
completion_reports/
実装作業の完了レポートが保存されます。
- 命名規則:
<作業識別子>_COMPLETION_REPORT.md - 例:
CR-002_API_AUTHENTICATION_COMPLETION_REPORT.md - 詳細: 完了レポート作成ルール を参照
reports/
テスト結果レポートが自動保存されます。
- 命名規則:
TEST_RESULTS_YYYYMMDD_HHMMSS.txt - エラーログ:
TEST_ERRORS_YYYYMMDD_HHMMSS.txt - 詳細: テスト結果レポート を参照
run_reports/
Self-Healing / Orchestrator 実行ごとの Run レポートが保存されます。
- 命名規則:
RUN_{run_id}.md - 詳細: Run レポートポリシー を参照
🔗 関連リンク
- README.md - プロジェクトの概要とクイックスタート
- README_VENV.md - 仮想環境の簡単な使い方
最終更新: 2025-12-02