README 문서를 OS별/카테고리별 하위 문서(DOCS/)로 분리 및 인덱스 허브 개편

2026-11-07 13:33:45 +09:00
1 parent 687ebb0e0a
commit 53ca0fefa9
@@ -0,0 +1,58 @@
+# README.md OS별·카테고리별 문서 분할 개편 계획 (SPLIT-README-DOCS-IMP-PLAN)
+
+## 1. 개요
+기존 단일 `README.md` 파일(811라인)이 비대해져 원하는 운영체제와 도구의 설치 명령어를 빠르게 찾기 어려운 문제를 해결하기 위해, **OS별(macOS/Linux, Windows) × 5대 카테고리별**로 총 10개의 독립 가이드 문서(`DOCS/` 디렉토리 내 영문 대문자+`-` 규칙 준수)로 분리하고, 메인 `README.md`는 직관적인 네비게이션 허브로 개편합니다.
+
+```mermaid
+flowchart TD
+    README["README.md (메인 인덱스 허브)"]
+    NEC["NECESSARY.md (필수 핵심 도구 모음)"]
+    README --> NEC
+
+    subgraph UNIX["🍎 macOS / 🐧 Linux (Bash)"]
+        U1["DOCS/UNIX-01-TERMINAL-FILE.md<br/>1. 터미널 관리 & 파일 유틸리티"]
+        U2["DOCS/UNIX-02-SYSTEM-DEVOPS.md<br/>2. 시스템 & 컨테이너 DevOps"]
+        U3["DOCS/UNIX-03-DEV-UTILS.md<br/>3. 개발 유틸리티"]
+        U4["DOCS/UNIX-04-AI-AGENTS.md<br/>4. AI 개발 에이전트"]
+        U5["DOCS/UNIX-05-VIBE-ASSISTANTS.md<br/>5. 바이브 코딩 도우미"]
+    end
+
+    subgraph WIN["💻 Windows (PowerShell / CMD)"]
+        W1["DOCS/WIN-01-TERMINAL-FILE.md<br/>1. 터미널 관리 & 파일 유틸리티"]
+        W2["DOCS/WIN-02-SYSTEM-DEVOPS.md<br/>2. 시스템 & 컨테이너 DevOps"]
+        W3["DOCS/WIN-03-DEV-UTILS.md<br/>3. 개발 유틸리티"]
+        W4["DOCS/WIN-04-AI-AGENTS.md<br/>4. AI 개발 에이전트"]
+        W5["DOCS/WIN-05-VIBE-ASSISTANTS.md<br/>5. 바이브 코딩 도우미"]
+    end
+
+    README --> UNIX
+    README --> WIN
+```
+
+## 2. 작업 단계 및 체크리스트
+
+### 단계 1: 실행 계획 수립
+- [x] 작업 계획서(`VIBE-WORK/261107/SPLIT-README-DOCS-IMP-PLAN.md`) 작성
+
+### 단계 2: macOS / Linux (`UNIX-*`) 카테고리별 문서 5종 생성
+- [x] `DOCS/UNIX-01-TERMINAL-FILE.md` 작성 (tmux, rmux, Helix, superfile, dua 설치 및 상세 사용법)
+- [x] `DOCS/UNIX-02-SYSTEM-DEVOPS.md` 작성 (Docker, bottom, all-smi, ctop, lazydocker 설치 및 상세 사용법)
+- [x] `DOCS/UNIX-03-DEV-UTILS.md` 작성 (lazygit, uv, VSCodium 설치 및 상세 사용법)
+- [x] `DOCS/UNIX-04-AI-AGENTS.md` 작성 (Antigravity CLI, Claude Code, Codex CLI, OpenCode, pi 설치 및 상세 사용법)
+- [x] `DOCS/UNIX-05-VIBE-ASSISTANTS.md` 작성 (graphify, Open Code Review 설치 및 상세 사용법)
+
+### 단계 3: Windows (`WIN-*`) 카테고리별 문서 5종 생성
+- [x] `DOCS/WIN-01-TERMINAL-FILE.md` 작성 (tmux/psmux, rmux, Helix, superfile, dua 설치 및 상세 사용법)
+- [x] `DOCS/WIN-02-SYSTEM-DEVOPS.md` 작성 (Docker, bottom, all-smi, ctop, lazydocker 설치 및 상세 사용법)
+- [x] `DOCS/WIN-03-DEV-UTILS.md` 작성 (lazygit, uv, VSCodium 설치 및 상세 사용법)
+- [x] `DOCS/WIN-04-AI-AGENTS.md` 작성 (Antigravity CLI, Claude Code, Codex CLI, OpenCode, pi 설치 및 상세 사용법)
+- [x] `DOCS/WIN-05-VIBE-ASSISTANTS.md` 작성 (graphify, Open Code Review 설치 및 상세 사용법)
+
+### 단계 4: 메인 `README.md` 허브 개편
+- [x] OS별 × 카테고리별 바로가기 매트릭스 테이블 및 도구별 바로가기 링크 구성
+- [x] `NECESSARY.md` (필수 유틸 모음) 안내 및 Mermaid 문서 구조도 포함
+
+### 단계 5: 완료 보고서 작성 및 Graphify 갱신 / Git 푸시
+- [x] 완료 보고서(`VIBE-WORK/261107/SPLIT-README-DOCS-PHASE01.md`) 작성
+- [x] `uv tool run --from graphifyy graphify update .` 실행
+- [x] Git commit 및 push
@@ -0,0 +1,44 @@
+# README.md OS별·카테고리별 문서 분할 개편 완료 보고서 (SPLIT-README-DOCS-PHASE01)
+
+## 1. 개요
+기존 811줄에 달하던 단일 `README.md` 문서를 **운영체제(macOS/Linux, Windows) × 5대 카테고리별**로 총 10개의 독립 가이드 문서(`DOCS/UNIX-01~05`, `DOCS/WIN-01~05`)로 분리하고, 메인 `README.md`는 원하는 운영체제와 카테고리로 즉시 이동할 수 있는 깔끔한 인덱스 허브로 전면 개편하였습니다.
+
+```mermaid
+flowchart LR
+    README["README.md<br/>(메인 인덱스 허브)"]
+    NEC["NECESSARY.md<br/>(필수 도구 요약본)"]
+    README --> NEC
+
+    subgraph UNIX["🍎 macOS / 🐧 Linux (DOCS/UNIX-*.md)"]
+        U1["UNIX-01-TERMINAL-FILE.md"]
+        U2["UNIX-02-SYSTEM-DEVOPS.md"]
+        U3["UNIX-03-DEV-UTILS.md"]
+        U4["UNIX-04-AI-AGENTS.md"]
+        U5["UNIX-05-VIBE-ASSISTANTS.md"]
+    end
+
+    subgraph WIN["💻 Windows (DOCS/WIN-*.md)"]
+        W1["WIN-01-TERMINAL-FILE.md"]
+        W2["WIN-02-SYSTEM-DEVOPS.md"]
+        W3["WIN-03-DEV-UTILS.md"]
+        W4["WIN-04-AI-AGENTS.md"]
+        W5["WIN-05-VIBE-ASSISTANTS.md"]
+    end
+
+    README --> UNIX
+    README --> WIN
+```
+
+## 2. 분할 생성된 문서 목록
+
+| 구분 | macOS / Linux (Bash) | Windows (PowerShell / CMD) |
+| :--- | :--- | :--- |
+| **1. 터미널 관리 & 파일 유틸리티** | `DOCS/UNIX-01-TERMINAL-FILE.md` | `DOCS/WIN-01-TERMINAL-FILE.md` |
+| **2. 시스템 & 컨테이너 DevOps** | `DOCS/UNIX-02-SYSTEM-DEVOPS.md` | `DOCS/WIN-02-SYSTEM-DEVOPS.md` |
+| **3. 개발 유틸리티 & 에디터** | `DOCS/UNIX-03-DEV-UTILS.md` | `DOCS/WIN-03-DEV-UTILS.md` |
+| **4. AI 개발 에이전트** | `DOCS/UNIX-04-AI-AGENTS.md` | `DOCS/WIN-04-AI-AGENTS.md` |
+| **5. 바이브 코딩 도우미** | `DOCS/UNIX-05-VIBE-ASSISTANTS.md` | `DOCS/WIN-05-VIBE-ASSISTANTS.md` |
+
+## 3. 개선 효과
+- **즉각적인 탐색성**: 메인 `README.md` 상단 매트릭스 표에서 본인의 OS와 원하는 카테고리 링크만 클릭하면 해당 OS 전용 원클릭 설치 명령어와 단축키 안내만 깔끔하게 확인할 수 있습니다.
+- **상호 네비게이션**: 각 하위 문서 상단/하단에 메인 `README.md` 복귀 링크, 반대편 OS 문서 전환 링크, 이전/다음 카테고리 이동 링크를 모두 배치하여 문서 간 이동이 편리합니다.