For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
기본 탐색
Codex

Codex use case

대규모 코드베이스 이해하기

요청 플로우를 추적하고, 낯선 모듈의 구조를 파악하며, 필요한 파일을 빠르게 찾으세요.

Difficulty 쉬움
Time horizon 5분

Codex로 낯선 코드베이스의 구조를 파악하고 각 모듈과 데이터 플로우에 관한 설명을 얻은 뒤, 코드를 수정하기 전에 다음으로 살펴볼 파일을 찾으세요.

적합한 대상

  • 새 레포지토리 또는 서비스에 온보딩하는 신규 엔지니어
  • 기능을 변경하기 전에 작동 방식을 이해하려는 모든 사람

Contents

    ← 모든 사용 사례

    대규모 코드베이스 이해하기

    요청 플로우를 추적하고, 낯선 모듈의 구조를 파악하며, 필요한 파일을 빠르게 찾으세요.

    Codex로 낯선 코드베이스의 구조를 파악하고 각 모듈과 데이터 플로우에 관한 설명을 얻은 뒤, 코드를 수정하기 전에 다음으로 살펴볼 파일을 찾으세요.

    쉬움
    5분

    Codex로 낯선 코드베이스의 구조를 파악하고 각 모듈과 데이터 플로우에 관한 설명을 얻은 뒤, 코드를 수정하기 전에 다음으로 살펴볼 파일을 찾으세요.

    쉬움
    5분

    적합한 대상

    • 새 레포지토리 또는 서비스에 온보딩하는 신규 엔지니어
    • 기능을 변경하기 전에 작동 방식을 이해하려는 모든 사람

    시작 프롬프트

    코드베이스의 <name of the system area>에서 요청이 어떻게 흐르는지 설명해 주세요. 다음을 포함해 주세요: - 각 모듈이 담당하는 역할 - 데이터 검증이 이루어지는 위치 - 변경하기 전에 주의해야 할 주요 사항 마지막으로 다음에 읽어야 할 파일을 알려 주세요.
    코드베이스의 <name of the system area>에서 요청이 어떻게 흐르는지 설명해 주세요. 다음을 포함해 주세요: - 각 모듈이 담당하는 역할 - 데이터 검증이 이루어지는 위치 - 변경하기 전에 주의해야 할 주요 사항 마지막으로 다음에 읽어야 할 파일을 알려 주세요.

    소개

    레포지토리가 처음이거나 익숙하지 않은 기능을 맡았다면, 코드를 변경하기 전에 Codex로 구조와 맥락을 파악할 수 있습니다. 목표는 개괄적인 요약에 그치지 않고 요청 플로우를 따라가며 각 모듈의 담당 역할을 이해하고, 다음으로 읽어야 할 파일을 찾는 것입니다.

    사용 방법

    프로젝트가 처음이라면 Codex에게 전체 코드베이스를 설명해 달라고 요청하는 것부터 시작할 수 있습니다:

    이 레포지토리를 설명해 주세요

    기존 코드베이스에 새 기능을 추가해야 한다면 Codex에게 특정 시스템 영역을 설명해 달라고 요청할 수 있습니다. 요청 범위를 명확히 할수록 더 구체적인 설명을 받을 수 있습니다:

    1. 파악하려는 부분과 관련된 파일, 디렉터리 또는 기능 영역을 Codex에게 알려 주세요.
    2. 요청 플로우를 추적하고 비즈니스 로직, 전송 계층, 영속성 계층 또는 UI를 각각 어떤 모듈이 담당하는지 설명해 달라고 요청하세요.
    3. 코드를 수정하기 전에 검증, 사이드 이펙트 또는 상태 전환이 어디에서 일어나는지 물어보세요.
    4. 마지막으로 다음에 읽어야 할 파일과 위험한 부분을 물어보세요.

    유용한 온보딩 답변은 파일 이름만 나열하는 데 그치지 않고 구조와 흐름을 구체적으로 파악할 수 있게 해야 합니다. Codex는 최종적으로 주요 플로우와 위험한 부분을 설명하고, 수정을 시작하기 전에 살펴볼 다음 파일이나 중요한 확인 항목을 안내해야 합니다.

    후속 질문

    Codex의 첫 설명을 받은 뒤에는 직접 첫 수정을 해도 되겠다는 확신이 들 만큼 설명이 구체적일 때까지 질문을 이어가세요. 좋은 후속 질문은 대개 Codex가 가정, 숨겨진 종속성, 변경 후 중요한 확인 항목을 명확히 짚도록 유도합니다.

    • 실제 비즈니스 로직은 어느 모듈이 담당하고, 전송 계층이나 UI 계층은 어느 모듈이 담당하나요?
    • 검증은 어디에서 이루어지며, 그곳에서 어떤 가정을 강제하나요?
    • 이 플로우를 변경하면 놓치기 쉬운 관련 파일이나 백그라운드 작업은 무엇인가요?
    • 이 영역을 수정한 후에는 어떤 테스트나 검사를 실행해야 하나요?

    관련 사용 사례