58 lines
3.4 KiB
Markdown
58 lines
3.4 KiB
Markdown
|
# 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
|