refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434)

* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
2025-12-29 16:16:08 +00:00 · 2025-10-16 00:37:39 +09:00
parent 7c14a31bc3
commit d5dfd7da21
60 changed files with 836 additions and 886 deletions
--- a/docs/Development/ARCHITECTURE.md
+++ b/docs/Development/ARCHITECTURE.md
@@ -236,7 +236,7 @@ Session End:
    "learned": ["Session Lifecycle pattern", "PDCA automation"]
  },
  "next_actions": [
-    "Create docs/Development/ structure",
+    "Create docs/development/ structure",
    "Write ARCHITECTURE.md",
    "Configure Serena MCP server"
  ]
--- a/docs/Development/PROJECT_STATUS.md
+++ b/docs/Development/PROJECT_STATUS.md
@@ -48,11 +48,11 @@
 - ✅ Agents/pm-agent.md updated

 ### Documentation
- ✅ docs/Development/ARCHITECTURE.md
- ✅ docs/Development/ROADMAP.md
- ✅ docs/Development/TASKS.md
- ✅ docs/Development/PROJECT_STATUS.md
- ✅ docs/pm-agent-implementation-status.md
+- ✅ docs/development/ARCHITECTURE.md
+- ✅ docs/development/ROADMAP.md
+- ✅ docs/development/TASKS.md
+- ✅ docs/development/PROJECT_STATUS.md
+- ✅ docs/PM_AGENT.md

 ---

@@ -135,7 +135,7 @@
 ### Week 2-3
 - [ ] Implement PM Agent Core (session_lifecycle, pdca_engine, memory_ops)
 - [ ] Write unit tests
- [ ] Update User-Guide documentation
+- [ ] Update user-guide documentation

 ### Week 4-5
 - [ ] Configure Serena MCP server
@@ -147,7 +147,7 @@
 ## 📝 Recent Changes

 ### 2025-10-14
- Created docs/Development/ structure
+- Created docs/development/ structure
 - Wrote ARCHITECTURE.md (system overview)
 - Wrote ROADMAP.md (5-phase development plan)
 - Wrote TASKS.md (task tracking)
--- a/docs/Development/ROADMAP.md
+++ b/docs/Development/ROADMAP.md
@@ -31,7 +31,7 @@ Transform SuperClaude into a self-improving development platform with PM Agent m

 ### Tasks

- [x] Create `docs/Development/` directory structure
+- [x] Create `docs/development/` directory structure
 - [x] Write `ARCHITECTURE.md` - System overview with PM Agent position
 - [x] Write `ROADMAP.md` - Phase-based development plan with checkboxes
 - [ ] Write `TASKS.md` - Current task tracking system
@@ -40,11 +40,11 @@ Transform SuperClaude into a self-improving development platform with PM Agent m

 ### Deliverables

- [x] **docs/Development/ARCHITECTURE.md** - Complete system architecture
- [x] **docs/Development/ROADMAP.md** - This file (development roadmap)
- [ ] **docs/Development/TASKS.md** - Task management with checkboxes
- [ ] **docs/Development/PROJECT_STATUS.md** - Current status and metrics
- [ ] **docs/Development/pm-agent-integration.md** - Integration procedures
+- [x] **docs/development/ARCHITECTURE.md** - Complete system architecture
+- [x] **docs/development/ROADMAP.md** - This file (development roadmap)
+- [ ] **docs/development/TASKS.md** - Task management with checkboxes
+- [ ] **docs/development/PROJECT_STATUS.md** - Current status and metrics
+- [ ] **docs/development/pm-agent-integration.md** - Integration procedures

 ### Success Criteria

@@ -69,9 +69,9 @@ Transform SuperClaude into a self-improving development platform with PM Agent m
 #### Documentation Updates
 - [x] Update `superclaude/Commands/pm.md` with Session Lifecycle
 - [x] Update `superclaude/Agents/pm-agent.md` with PDCA Cycle
- [x] Create `docs/pm-agent-implementation-status.md`
- [ ] Update `docs/User-Guide/agents.md` - Add PM Agent section
- [ ] Update `docs/User-Guide/commands.md` - Add /sc:pm command
+- [x] Create `docs/PM_AGENT.md`
+- [ ] Update `docs/user-guide/agents.md` - Add PM Agent section
+- [ ] Update `docs/user-guide/commands.md` - Add /sc:pm command

 #### Core Implementation
 - [ ] Implement `superclaude/Core/session_lifecycle.py`
@@ -100,7 +100,7 @@ Transform SuperClaude into a self-improving development platform with PM Agent m
 ### Deliverables

 - [x] **Updated pm.md and pm-agent.md** - Design documentation
- [x] **pm-agent-implementation-status.md** - Status tracking
+- [x] **PM_AGENT.md** - Status tracking
 - [ ] **superclaude/Core/session_lifecycle.py** - Session management
 - [ ] **superclaude/Core/pdca_engine.py** - PDCA automation
 - [ ] **superclaude/Core/memory_ops.py** - Memory operations
@@ -269,7 +269,7 @@ Transform SuperClaude into a self-improving development platform with PM Agent m
 ### Deliverables

 - [ ] **superclaude/Core/auto_activation.py** - Auto-activation system
- [ ] **docs/Developer-Guide/auto-activation.md** - Implementation guide
+- [ ] **docs/developer-guide/auto-activation.md** - Implementation guide
 - [ ] **tests/test_auto_activation.py** - Auto-activation tests
 - [ ] **Performance Report** - Startup time impact analysis

--- a/docs/Development/TASKS.md
+++ b/docs/Development/TASKS.md
@@ -8,7 +8,7 @@
 ## 🔥 High Priority (This Week: 2025-10-14 ~ 2025-10-20)

 ### Phase 1: Documentation Structure
- [x] Create docs/Development/ directory
+- [x] Create docs/development/ directory
 - [x] Write ARCHITECTURE.md
 - [x] Write ROADMAP.md
 - [ ] Write TASKS.md (this file)
@@ -21,7 +21,7 @@
 - [x] Design PDCA Cycle
 - [x] Update Commands/pm.md
 - [x] Update Agents/pm-agent.md
- [x] Create pm-agent-implementation-status.md
+- [x] Create PM_AGENT.md
 - [ ] Commit PM Agent Mode changes

 ---
@@ -33,7 +33,7 @@
 - [ ] Implement superclaude/Core/pdca_engine.py
 - [ ] Implement superclaude/Core/memory_ops.py
 - [ ] Write unit tests for PM Agent core
- [ ] Update User-Guide documentation
+- [ ] Update user-guide documentation

 ### Testing & Validation
 - [ ] Create test suite for session_lifecycle
@@ -84,8 +84,8 @@
 ### 2025-10-14
 - [x] Salvaged PM Agent mode changes from ~/.claude
 - [x] Cleaned up ~/.claude git repository
- [x] Created pm-agent-implementation-status.md
- [x] Created docs/Development/ directory
+- [x] Created PM_AGENT.md
+- [x] Created docs/development/ directory
 - [x] Wrote ARCHITECTURE.md
 - [x] Wrote ROADMAP.md
 - [x] Wrote TASKS.md
--- a/docs/Development/installation-flow-understanding.md
+++ b/docs/Development/installation-flow-understanding.md
@@ -286,7 +286,7 @@ Read ~/.claude/commands/sc/pm.md
 ### Phase 3: 改善案作成
 ```bash
 # このプロジェクト内で（Git管理）
-Write docs/Development/hypothesis-pm-enhancement-2025-10-14.md
+Write docs/development/hypothesis-pm-enhancement-2025-10-14.md

 内容:
 - 現状の問題（ドキュメント寄りすぎ、PMO機能不足）
--- a/docs/Development/pm-agent-ideal-workflow.md
+++ b/docs/Development/pm-agent-ideal-workflow.md
@@ -23,12 +23,12 @@
 1. ドキュメント読み込み:
   優先順位:
     1. タスク管理ドキュメント → 進捗確認
-        - docs/Development/tasks/current-tasks.md
+        - docs/development/tasks/current-tasks.md
        - 前回どこまでやったか
        - 次に何をすべきか

     2. アーキテクチャドキュメント → 仕組み理解
-        - docs/Development/architecture-*.md
+        - docs/development/architecture-*.md
        - このプロジェクトの構造
        - インストールフロー
        - コンポーネント連携
@@ -36,7 +36,7 @@
     3. 禁止事項・ルール → 制約確認
        - CLAUDE.md（グローバル）
        - PROJECT/CLAUDE.md（プロジェクト固有）
-        - docs/Development/constraints.md
+        - docs/development/constraints.md

     4. 過去の学び → 同じミスを防ぐ
        - docs/mistakes/ （失敗記録）
@@ -88,7 +88,7 @@
 ```yaml
 1. 改善仮説作成:
   # このプロジェクト内で（Git管理）
-   File: docs/Development/hypothesis-YYYY-MM-DD.md
+   File: docs/development/hypothesis-YYYY-MM-DD.md

   内容:
   - 現状の問題点
@@ -127,7 +127,7 @@
   - quality-engineer: テスト設計

 2. 実装記録:
-   File: docs/Development/experiment-YYYY-MM-DD.md
+   File: docs/development/experiment-YYYY-MM-DD.md

   内容:
   - 試行錯誤の記録
@@ -194,7 +194,7 @@
   - チェックリスト

 3. タスク更新:
-   File: docs/Development/tasks/current-tasks.md
+   File: docs/development/tasks/current-tasks.md

   内容:
   - 完了したタスク
@@ -292,7 +292,7 @@ docs/
 │   └── experiment-*.md  # 実験記録
 ├── patterns/            # 成功パターン（清書後）
 ├── mistakes/            # 失敗記録と防止策
-└── (既存のUser-Guide等)
+└── (既存のuser-guide等)
 ```

 ---
@@ -335,7 +335,7 @@ docs/

 このドキュメント作成後:
 1. 既存のインストールロジック理解（setup/components/）
-2. タスク管理ドキュメント作成（docs/Development/tasks/）
+2. タスク管理ドキュメント作成（docs/development/tasks/）
 3. PM Agent実装修正（このワークフローを実際に実装）

 このドキュメント自体が**PM Agentの憲法**となる。
--- a/docs/Development/pm-agent-integration.md
+++ b/docs/Development/pm-agent-integration.md
@@ -466,7 +466,7 @@ tests/integration/

 - [ARCHITECTURE.md](./ARCHITECTURE.md) - System architecture
 - [ROADMAP.md](./ROADMAP.md) - Development roadmap
- [pm-agent-implementation-status.md](../pm-agent-implementation-status.md) - Status tracking
+- [PM_AGENT.md](../PM_AGENT.md) - Status tracking
 - [Commands/pm.md](../../superclaude/Commands/pm.md) - PM Agent command
 - [Agents/pm-agent.md](../../superclaude/Agents/pm-agent.md) - PM Agent persona

--- a/docs/Development/project-structure-understanding.md
+++ b/docs/Development/project-structure-understanding.md
@@ -146,7 +146,7 @@ cat ~/.claude/commands/sc/pm.md      # 現在の仕様確認
 cd ~/github/SuperClaude_Framework

 # Git管理されているこのプロジェクト内で
-Write docs/Development/hypothesis-pm-improvement-YYYY-MM-DD.md
+Write docs/development/hypothesis-pm-improvement-YYYY-MM-DD.md

 # 内容例:
 # - 現状の問題
@@ -226,9 +226,9 @@ mv backup original
 ```

 ### Rule 3: ドキュメント駆動開発
-1. 理解 → docs/Development/ に記録
-2. 仮説 → docs/Development/hypothesis-*.md
-3. 実験 → docs/Development/experiment-*.md
+1. 理解 → docs/development/ に記録
+2. 仮説 → docs/development/hypothesis-*.md
+3. 実験 → docs/development/experiment-*.md
 4. 成功 → docs/patterns/
 5. 失敗 → docs/mistakes/

@@ -336,7 +336,7 @@ vim ~/.claude/commands/sc/pm.md
 ```bash
 # ✅ CORRECT
 1. setup/components/ でロジック理解
-2. docs/Development/ に改善案記録
+2. docs/development/ に改善案記録
 3. setup/ 側で変更・テスト
 4. Git コミット
 5. SuperClaude install --dev で動作確認
@@ -357,7 +357,7 @@ vim ~/.claude/commands/sc/pm.md
   - 現在の動作理解

 3. **改善提案作成**
-   - `docs/Development/hypothesis-*.md` 作成
+   - `docs/development/hypothesis-*.md` 作成
   - ユーザーレビュー

 4. **実装・テスト**
--- a/docs/Development/tasks/current-tasks.md
+++ b/docs/Development/tasks/current-tasks.md
@@ -20,22 +20,22 @@

 ### Phase 1: ドキュメント基盤整備
 - [x] **PM Agent理想ワークフローをドキュメント化**
-  - File: `docs/Development/pm-agent-ideal-workflow.md`
+  - File: `docs/development/pm-agent-ideal-workflow.md`
  - Content: 完璧なワークフロー（7フェーズ）
  - Purpose: 次回セッションで同じ説明を繰り返さない

 - [x] **プロジェクト構造理解をドキュメント化**
-  - File: `docs/Development/project-structure-understanding.md`
+  - File: `docs/development/project-structure-understanding.md`
  - Content: Git管理とインストール後環境の区別
  - Purpose: 何百回も説明した内容を外部化

 - [x] **インストールフロー理解をドキュメント化**
-  - File: `docs/Development/installation-flow-understanding.md`
+  - File: `docs/development/installation-flow-understanding.md`
  - Content: CommandsComponent動作の完全理解
  - Source: `superclaude/commands/*.md` → `~/.claude/commands/sc/*.md`

 - [x] **ディレクトリ構造作成**
-  - `docs/Development/tasks/` - タスク管理
+  - `docs/development/tasks/` - タスク管理
  - `docs/patterns/` - 成功パターン記録
  - `docs/mistakes/` - 失敗記録と防止策

@@ -58,7 +58,7 @@
 - [ ] **改善提案ドキュメント作成**
  - Status: Pending
  - Action: 仮説ドキュメント作成
-  - File: `docs/Development/hypothesis-pm-enhancement-2025-10-14.md`
+  - File: `docs/development/hypothesis-pm-enhancement-2025-10-14.md`
  - Content:
    - 現状の問題点（ドキュメント寄り、PMO機能不足）
    - 改善案（自律的PDCA、自己評価）
@@ -130,7 +130,7 @@
  - テスト時のバックアップ・復元必須

 - **ドキュメント駆動開発**
-  - 理解 → docs/Development/ に記録
+  - 理解 → docs/development/ に記録
  - 仮説 → hypothesis-*.md
  - 実験 → experiment-*.md
  - 成功 → docs/patterns/