인프런 커뮤니티 질문&답변

빠르게 답변해주셔서 너무 감사합니다. :)

md 파일만들었는데 /output-style 에 커스터마이징되지 않습니다

안녕하세요! 🙂

세 파일 모두 마크다운(.md) 파일이지만, 누구를 위한 문서인지가 다릅니다.

CLAUDE.md는 클로드 코드(AI)를 위한 문서예요. 클로드 코드가 프로젝트에서 작업할 때 "이 프로젝트는 이런 규칙으로 개발해줘", "이런 기술 스택을 쓰고 있어" 같은 지침을 적어두는 파일입니다. 사람이 아니라 AI가 읽고 따르는 설명서라고 생각하시면 돼요.

README.md는 사람(개발자)을 위한 문서예요. GitHub에서 프로젝트에 들어가면 가장 먼저 보이는 문서가 바로 이 파일인데요, "이 프로젝트가 뭔지", "어떻게 설치하고 실행하는지" 등을 설명합니다. 프로젝트의 소개서 같은 역할이에요.

ROADMAP.md도 사람을 위한 문서인데, 프로젝트의 향후 계획을 정리한 파일이에요. "앞으로 어떤 기능을 추가할 건지", "어떤 순서로 개발할 건지" 같은 로드맵을 담고 있습니다. 모든 프로젝트에 있는 건 아니고, 필요에 따라 만드는 파일이에요.

그리고 강의에서 보신 것처럼 CLAUDE.md 안에서 @ROADMAP.md로 다른 파일을 참조할 수도 있어요. 이렇게 하면 클로드 코드가 CLAUDE.md를 읽을 때 ROADMAP.md의 내용도 함께 참고하게 됩니다. 즉, 사람을 위해 작성한 ROADMAP.md를 AI에게도 공유하는 셈이에요. "이 로드맵에 맞춰서 개발해줘"라고 컨텍스트를 넘겨주는 거죠 ㅎㅎ

정리하면 CLAUDE.md는 AI용, README.md와 ROADMAP.md는 사람용 문서이고, @ 참조를 통해 사람용 문서도 AI에게 컨텍스트로 전달할 수 있습니다. 이 강의에서 특히 중요한 건 CLAUDE.md인데, 클로드 코드에게 프로젝트 컨텍스트를 잘 전달하는 핵심 수단이거든요 🙏

안녕하세요, 인프런 AI 인턴입니다. nomonomo님.

CLAUDE.md, ROADMAP.md, README.md는 각각 다른 목적을 갖고 있는 파일들입니다. 간단히 설명드리자면 다음과 같습니다:

1. CLAUDE.md:

   • 목적: Claude AI(클로드 AI)와 통합된 시스템에서 사용하는 특별한 메모리 파일입니다. 주로 프로젝트 전반에 걸친 규칙이나 지침을 포함하여 클로드 AI가 작업 과정에서 언제든 확인할 수 있는 정보들을 담고 있습니다. 클로드 AI가 프로젝트와 관련하여 항상 알아야 할 중요한 정보를 중심으로 작성됩니다.
     
   • 관련 질문: “해당 내용은 memory 파일이라고 강의를 들었습니다. 그렇다면 /init 을 사용하지 않고, 아래와 같이 작성한다면 생성된 ROADMAP.md 파일은 memory 파일이 아닌가요?”에서 유사 사례를 확인할 수 있습니다.
     

2. ROADMAP.md:

   • 목적: 프로젝트의 계획이나 개발 로드맵을 문서화한 파일입니다. 주로 프로젝트의 진행 상태, 목표, 단계 및 마일스톤을 나열하여 팀원들이 프로젝트의 전개를 한눈에 파악할 수 있도록 돕습니다. 코드 수행과 직접적으로 연결되기보다는 프로젝트 관리 측면에서 바라보는 파일입니다.
     
   • 관련 설명: 클로드 코드에서는 자동 참조되지 않는 파일로, 필요할 때 직접 내용을 참조하도록 작성합니다.
     

3. README.md:

   • 목적: 대부분의 프로젝트가 포함하고 있는 기본 문서 파일로, 프로젝트에 대한 전반적인 설명, 설치 및 사용법, 프로젝트의 개발 환경 및 요구사항 등을 자세히 기술합니다. 다른 개발자나 사용자들이 프로젝트를 시작하는 데 필수적인 정보를 제공합니다.
     
   • 특징: GitHub 등의 플랫폼에서 자동으로 프로젝트에 대한 첫 인상을 줄 수 있는 문서로, 프로젝트의 첫 관문 역할을 합니다.
     

각 파일의 핵심 목적을 이해하시면, 파일들을 적절하게 활용하여 프로젝트 문서화를 관리하실 수 있습니다.

저는 질문자님의 이해를 돕고자 지식공유자님의 기존 답변을 참고하여 유사한 답변 링크를 추천해드리고 있습니다. 현재 베타 기능으로 답변이 만족스럽지 않을 수 있는 점 양해 부탁드립니다. 🙏 추가적으로 궁금한 점이 있으시면, 이어서 질문해 주세요. 곧 지식공유자께서 답변해 주실 것입니다.