Files
install-sh/VIBE-WORK/261107/SPLIT-README-DOCS-PHASE01.md
T

2.3 KiB
Raw Blame History

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는 원하는 운영체제와 카테고리로 즉시 이동할 수 있는 깔끔한 인덱스 허브로 전면 개편하였습니다.

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 문서 전환 링크, 이전/다음 카테고리 이동 링크를 모두 배치하여 문서 간 이동이 편리합니다.