인프런 커뮤니티 질문&답변
작성한 질문수
가이드문서에 관하여
작성
·
45
0
121강 2분 52초에 붙여넣는 가이드 문서에 대해서 질문드립니다.
1강부터 121강까지 오면서 최대한 모든 내용을 흡수하고 싶어서 따라할 필요 없다고 하신 부분도 전부 따라하면서 따라왔습니다. 또한 거기에 더해 현재 제가 진행중인 프로젝트들에 내 워크플로우로 적용해보려고 배운 내용을 활용해서 여러 과정을 시도해보고 여러 서브에이전트(개발용, 문서용 등), CLAUDE.md 메모리, mcp와 커스텀커맨드, task master ai를 활용한 태스크관리 등을 열심히 파봤는데,
정말 머릿속에서 명확히 하고 싶었던 개념이 바로 CLAUDE.md 메모리에서 프로젝트 구조, 개발지침, 서비스 정책 등을 전부 기술하지 않고 분리한 다음 CLAUDE.md에서는 해당 문서 위치만 참조하도록 참조위치를 남기는 것입니다. 그런데 지금껏 실습을 하던 과정에서 저 docs/guides 하위 5가지 문서를 어떤 과정으로 만드는지에 대한 내용을 다룬 적이 없는 것 같아 이전 강의들을 전부 돌려보면서 확인해보는데 찾을 수가 없었습니다.
제공해주신 깃허브 커밋히스토리를 찾아보다가
https://github.com/gymcoding/claude-nextjs-starters/commit/c26931ffa7713ace09151123dc83819402235976
해당 커밋에 스타터킷 관련 내용 강의 중 처음 추가된 것으로 생각되는데, 스타터킷 섹션에서 어떤 플로우로 이러한 가이드문서를 제작하고 지속적으로 수정해나가면서 더 좋은 가이드문서를 만들어내는지에 대한 내용을 도저히 찾을 수가 없습니다.
혹시 제가 찾지 못하는건가요? 아니면 강의로 직접 다루진 않았으나 잠깐 언급하시는 형태로 넘어갔었나요? 너무 배우고 싶은 내용입니다..
저 가이드 문서를 만드는 과정이 처음에는 공식문서 링크를 던져주면서 가이드를 제작하라는 프롬프트를 입력해서 제작을 하신 건지, 아니면 프로젝트 기술 스택을 함께 입력해서 보편적으로 사용되는 규칙들을 직접 프롬프트하신건지 너무 궁금합니다. 아니면 다른 방법인가요?
어떻게 보면 "범용적으로" 어떤 nextjs + shadcnui + tailwindcss + react hook + .. 의 환경을 사용하는 모든 프로젝트에 적용할 수 있는 가이드를 제작하신 건데, 어떻게 제작하고 CLAUDE.md에 연결하게 되신 건지 과정이 너무 궁금합니다. 또는 가이드문서를 따로 두는 기준이 있나요? 저 다섯가지로 초기에 구성한 이유가 궁금합니다.
질문 요약
1. 2:52에 붙여넣는 가이드문서들이 어떻게 만들어졌는지, 지난 강의에 해당 과정을 정확히 보여주신 부분이 있다면 해당 회차라도 알려주실 수 있나요?
2. 어떻게 "범용적으로" 사용가능한 개발 가이드 문서를 만드신 건가요? 그리고 가이드 문서를 따로 분리해야겠다고 생각하신 기준이 무엇인가요? CLAUDE.md의 길이가 길어지는 이유를 제외한 기준이 궁금합니다. 또한 분리를 결정하면 초기버전을 어떻게 제작하시는지 궁금합니다.
답변 2
0
안녕하세요! 🙂
강의에서 직접 다루진 않았어요. 제가 스타터킷에 추가한 문서인데, 만드는 방법은 정말 간단해요.
내용이 짧은 경우엔 바로 복사해서 붙여넣기:
"아래 내용은 Tailwind CSS 공식 문서야. 이 프로젝트에서 참고할 수 있도록
docs/guides/tailwind.md파일로 정리해줘. [복사한 내용 붙여넣기]"
내용이 긴 경우엔 파일로 저장 후 @ 참조:
"아래 파일은 Tailwind CSS 공식 문서야. 이 프로젝트에서 참고할 수 있도록
docs/guides/tailwind.md파일로 정리해줘. @raw/tailwind-docs.txt"
거창한 게 아니라 공식 문서를 프로젝트에 맞게 메모해둔 것에 가까워요. CLAUDE.md에 모든 내용을 때려넣으면 길어지니까, 자주 참조할 내용은 파일로 빼고 CLAUDE.md에는 경로만 남겨두는 방식이에요.
팁으로 하나 더 말씀드리면,
복잡한 자료를 수집해서 md 파일로 만들고 싶을 때는 병렬 서브에이전트를 활용하는 방법도 있어요. [링크] 이 회차에서 web PPT 만드는 방법을 리서치해서 md 파일로 만드는 과정을 다루고 있는데, 여러 자료를 동시에 수집해서 하나의 컨텍스트 파일로 정리하는 흐름을 참고하시면 도움이 될 거예요 🙂
감사합니다!
0
안녕하세요, 인프런 AI 인턴입니다. 이예찬님.
질문해 주신 내용을 바탕으로 클로드 코드 강의에서의 가이드문서 작성 및 관리에 대한 방법을 설명드리겠습니다.
1. 가이드 문서 제작 과정과 강의 내 존재 여부
먼저, 121강에서 2분 52초에 등장하는 가이드 문서의 존재에 대해 말씀드리면, 클로드 코드는 일반적으로 특정 규격에 맞게 프로젝트를 세팅하고 문서화하지만, 모든 과정을 세세하게 다루지는 않을 수도 있습니다. 이는 복잡한 AI 개발 환경에서는 선제적인 지침과 메타데이터가 필요할 수 있음을 보여주는 사례로 볼 수 있습니다.
직접적으로 강의에서 이러한 문서 작성이나 제작 과정을 분명히 보여주지 않는 경우도 있을 수 있습니다. 그럴 경우, 지식을 얻기 위해서는 관련된 프로젝트 문서, 혹은 지침으로 제공되는 커밋 내용 등을 기반으로 학습해야 합니다.
강의에서 이 과정을 명시적으로 보여주지 않았다면, 강의 커밋 히스토리를 통해서 커맨드나 지침을 이해하려는 시도를 추천합니다.
2. 범용적 사용 가능성 및 문서 분리 기준
범용적인 개발 가이드 문서는 다음과 같은 절차를 통해 제작할 수 있습니다:
- 프롬프트 설계: 클로드 코드나 AI 기반의 도구가 이해할 수 있도록 프로젝트의 기술 스택과 서비스 정책 등을 꼼꼼하게 프롬프트합니다. 이때 특정 API 문서나 기술 블로그, 공식 문서 등을 기반으로 AI에게 기본 정보를 제공합니다.
- 프로젝트 범위와 환경 조사: 프로젝트 내에서 반복적으로 쓰이는 모범 사례를 규명하고 이를 문서에 체계적으로 정리합니다.
- 가이드 문서 업데이트: 개발 중간 중간에 생기는 기술 변경이나 정책 업데이트를 즉시 반영하여 항상 최신의 상태가 되도록 합니다.
문서를 따로 두는 기준은, CLAUDE.md의 길이 외에도 프로젝트의 복잡도, 각 도메인 특성(프론트엔드, 백엔드 등)을 고려하여 생성 및 분리할 수 있습니다. 초기에 문서를 제작할 때는 최소 요구 사항을 중심으로 정의하며, 이후 피드백을 바탕으로 업그레이드하는 방식이 권장됩니다.
범용적인 문서는 가장 기본적인 API 사용법, 코드 스타일 가이드라인, 에러 핸들링 방법 등을 포함하게 됩니다.
저는 질문자님의 이해를 돕고자 지식공유자님의 기존 답변을 참고하여 유사한 답변 링크를 추천해드리고 있습니다. 현재 베타 기능으로 답변이 만족스럽지 않을 수 있는 점 양해 부탁드립니다. 🙏 추가적으로 궁금한 점이 있으시면, 이어서 질문해 주세요. 곧 지식공유자께서 답변해 주실 것입니다.