docs: ドキュメント配置ルール(SSOT)確立
## 追加内容 - CLAUDE.md にドキュメント配置ルール(SSOT)セクション追加 - DOCS_LAYOUT.md (SSOT): 置き場所ルール定義 - phases/README.md: Phase ドキュメント説明 - design/README.md: 設計図ドキュメント説明 - investigations/README.md: 調査ログ説明 ## ルール概要 1. **Phase 文書** → phases/phase-<N>/ 2. **設計図** → design/ 3. **調査ログ** → investigations/ (結論を 10-Now/20-Decisions に反映) ## 導線 - CLAUDE.md で概要説明 - DOCS_LAYOUT.md で詳細定義(SSOT) - 各フォルダ README で参照方法 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This commit is contained in:
61
docs/development/current/main/investigations/README.md
Normal file
61
docs/development/current/main/investigations/README.md
Normal file
@ -0,0 +1,61 @@
|
||||
# 調査ログ・根本原因分析
|
||||
|
||||
このフォルダは、バグ修正・最適化の過程で発見した根本原因分析・調査プロセスを保管します。
|
||||
|
||||
## 参照方法
|
||||
|
||||
1. **「このバグの根本原因は?」** → investigations/ で検索
|
||||
2. **「この設計決定の背景は?」** → [../20-Decisions.md](../20-Decisions.md) で確認
|
||||
3. **「実装の詳細は?」** → [../phases/](../phases/README.md) で確認
|
||||
|
||||
## 命名規則
|
||||
|
||||
- **形式**: `<topic>-investigation-YYYY-MM-DD.md` または `<topic>-root-cause-analysis.md`
|
||||
- **目的**: 時系列が分かる形、または主題ごとに整理
|
||||
|
||||
## 最新調査
|
||||
|
||||
- `python-resolver-investigation.md` - Python LLVM バックエンド resolver.is_stringish() 調査
|
||||
- `phase131-11-root-cause-analysis.md` - PHI 型推論循環依存分析
|
||||
|
||||
## 作成ルール(SSOT)
|
||||
|
||||
詳しくは [../DOCS_LAYOUT.md](../DOCS_LAYOUT.md) を参照。
|
||||
|
||||
- ✅ **置き場所**: `investigations/` 配下のみ
|
||||
- ✅ **内容**: 詳細な根本原因分析、デバッグプロセス、試行錯誤の記録
|
||||
- ✅ **結論反映**: 調査結果の結論は以下に反映
|
||||
- [../10-Now.md](../10-Now.md) - 現在の進行状況サマリー
|
||||
- [../20-Decisions.md](../20-Decisions.md) - 設計決定記録
|
||||
- [../design/](../design/README.md) - アーキテクチャ設計書(必要な場合)
|
||||
- ❌ **避けるべき**: 調査ログそのものを SSOT にしない
|
||||
|
||||
## 使用例
|
||||
|
||||
### 調査ログ作成時
|
||||
```markdown
|
||||
# Python LLVM バックエンド resolver.is_stringish() 調査
|
||||
|
||||
**日時**: 2025-12-14
|
||||
**担当**: taskちゃん
|
||||
**目的**: Case C で Result: 0 が出力される原因特定
|
||||
|
||||
## 調査フロー
|
||||
1. ...
|
||||
2. ...
|
||||
|
||||
## 根本原因
|
||||
```
|
||||
|
||||
### 結論反映時(10-Now.md)
|
||||
```markdown
|
||||
## 🔍 Phase 131-11-E: TypeFacts/TypeDemands 分離
|
||||
|
||||
**根本原因**: MIR Builder の後方伝播型推論
|
||||
- **詳細**: [investigations/python-resolver-investigation.md](investigations/python-resolver-investigation.md)
|
||||
- **修正**: PhiTypeResolver が TypeFacts のみ参照
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**最終更新**: 2025-12-14
|
||||
Reference in New Issue
Block a user