md 파일을 위한 폴더 관리의 기준이 궁금합니다.

작성한 질문수 1

0

안녕하세요 🙂

결론부터 말씀드리면, 정해진 정답은 없지만 "누가 봐도(사람이든 클로드든) 찾기 쉬운 위치에 두는 것" 이 핵심 기준이에요.

제가 일반적으로 쓰는 분류 원칙은 이렇습니다.

루트(/)에 두는 파일

• README.md: 프로젝트 진입점 (GitHub에서 자동 렌더링됨)

• CLAUDE.md: 클로드 코드 전용 가이드

• LICENSE, CHANGELOG.md 등 표준 위치가 정해진 파일

/docs에 두는 파일

• PRD.md, ROADMAP.md, ARCHITECTURE.md 같은 기획·설계 문서

• 한 폴더에 모아두면 한눈에 보기 쉽고, 루트가 어수선해지지 않아요

기능/모듈 폴더 안에 두는 파일

• 특정 기능에만 해당하는 설명은 해당 코드 폴더에 두는 게 좋아요 (예: src/auth/README.md)

본질적으로는 클로드 코드도 사람처럼 폴더 구조에서 단서를 얻습니다. 그래서 "이 문서는 여기 있겠지"라고 직관적으로 떠오르는 위치에 두시면 됩니다. 루트가 어수선해질수록 사람도 찾기 어렵고 컨텍스트 효율도 떨어지니까, 기획 문서가 여러 개 생긴다 싶으면 /docs로 묶는 거예요.

가장 중요한 건 일관성이에요. 한 프로젝트 안에서 PRD는 /docs, ROADMAP은 루트, 이런 식으로 섞이지만 않으면 어떤 구조를 가져가셔도 무방합니다.

추가로 말씀드리면 오픈소스를 탐색했을때~ /docs, /context 이러한 디렉토리에 관리를 하더라고요 참고만해주세요,.

감사합니다 🙂

0

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

PRD.md, ROADMAP.md 등의 문서 파일을 /docs 폴더에 저장하는 이유는 주로 프로젝트 문서화의 일관성과 관리 용이성을 높이기 위함입니다.

폴더 관리 기준 및 노하우:

1. 문서의 용도에 따른 구분: 문서의 목적과 사용 용도에 따라 폴더를 구분합니다. 예를 들어, 프로젝트 관련 모든 문서를 /docs 폴더에 저장함으로써, 추후 문서 검색이나 관리에서 효율성을 기할 수 있습니다.

2. 일관된 구조 유지: 모든 프로젝트에서 일관된 폴더 구조를 유지하면, 개발자들이 문서를 찾고 접근하기 쉬워집니다. 예를 들어, 문서와 관련된 폴더는 항상 /docs로, 코드와 관련된 내용은 /src로 구분하는 것입니다.

3. 문서의 중요도나 범위에 따라 분류: 중요한 문서나 프로젝트의 중심이 되는 문서는 루트에 두거나, 별도로 분류하는 경우도 있습니다.

4. 버전 관리 및 이력 추적: git을 사용하여 폴더 안의 문서를 버전 관리하면 문서 업데이트 이력을 쉽고 효율적으로 추적할 수 있습니다.

이와 관련하여, 기존 답변을 참고해 보시면 유용한 정보를 얻을 수 있습니다:
- init 와 CLAUDE.md 파일 한글화에 대해 질문

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