CLAUDE.md에 뭘 적어 두면 매번 설명하지 않아도 되는지

같은 설명을 매번 처음부터 다시 하고 계신다면 이 파일부터 만드셔야 합니다.

클로드 코드는 프로젝트 폴더 안의 CLAUDE.md를 세션마다 읽습니다.

거기에 적어 둔 것은 말하지 않아도 지켜집니다.

프로젝트 폴더 맨 위에 `CLAUDE.md` 라는 이름으로 만들면 됩니다.

확장자에서 보이듯 그냥 텍스트 파일입니다. 특별한 형식이 없습니다.

사용자 폴더에도 둘 수 있습니다. 그러면 어느 프로젝트에서나 읽힙니다.

회사 공통 규칙은 사용자 폴더, 프로젝트마다 다른 것은 프로젝트 폴더에 둡니다

저희는 이렇게 나눠 두고 씁니다. 섞어 두면 관리가 안 됩니다.

파일 하나에 다 넣으려 하면 곧 아무도 안 읽는 파일이 됩니다.

매번 설명하게 되는 것을 적으면 됩니다.

이 프로젝트가 무엇인지, 어떻게 실행하는지, 어떤 규칙을 지켜야 하는지입니다.

저희 경우에는 실행 명령과 폴더 구조를 제일 먼저 적었습니다.

그것만 적어 둬도 "그 파일 어디 있냐"는 왕복이 사라집니다.

얼마나 자세히 적어야 하나요

새로 온 직원에게 설명하듯 적으시면 됩니다.

그 사람이 물어볼 것을 미리 적어 두는 셈입니다.

적어 두면 지켜지고, 안 적어 두면 매번 다르게 나옵니다.

처음부터 다 채우려 하지 마시고 걸릴 때마다 한 줄씩 늘리시면 됩니다.

실행 방법을 적어 둡니다

가장 효과가 큰 항목입니다.

이 프로젝트를 어떤 명령으로 돌리는지, 테스트는 어떻게 하는지입니다.

이게 없으면 매번 파일을 뒤져 가며 짐작합니다.

짐작이 틀리면 엉뚱한 명령이 나갑니다.

명령어 세 줄만 적어 둬도 왕복이 확 줄어듭니다

가상환경을 쓰는지, 환경변수가 필요한지도 함께 적으십시오.

저희는 이 부분을 안 적어 두고 며칠을 헤맸습니다.

하지 말아야 할 것을 적습니다

해야 할 것보다 이쪽이 더 중요합니다.

건드리면 안 되는 폴더, 지우면 안 되는 파일이 있습니다.

저희는 이미 발행된 결과물이 들어 있는 폴더를 여기에 적어 뒀습니다.

그걸 안 적어 뒀을 때 한 번 크게 당했습니다.

발행이 끝난 자료, 원본만 있는 자료, 되돌릴 수 없는 작업이 그 대상입니다.

한 줄로 적어 두면 그 뒤로는 물어보고 진행합니다.

그런 것까지 적어야 하나요

한 줄 적는 데 십 초 걸리고, 안 적어서 생기는 일은 하루가 갑니다.

그 계산이면 적는 편이 낫습니다.

말투와 형식도 적힙니다

코드만 적는 파일이 아닙니다.

글을 쓰게 시킨다면 그 글의 규칙도 여기 적어 둡니다.

저희는 "굵게 표시를 쓰지 않는다"를 여기 적어 뒀습니다

이런 건 매번 말하기 번거롭고, 잊으면 그대로 나갑니다.

문단 길이, 쓰지 않을 단어, 지켜야 할 호칭도 여기에 들어갑니다.

길어지면 읽히는 밀도가 떨어집니다.

한 화면에 들어오는 정도가 가장 좋습니다.

길어질 것 같으면 다른 문서로 빼고 여기서는 가리키기만 합니다.

이 파일은 목차에 가깝게 두는 편이 낫습니다

자세한 설명은 별도 문서에 두고 경로만 적어 두십시오.

다 넣으려다 아무도 안 읽는 파일이 되는 것이 흔한 실패입니다.

한 번 쓰고 끝나는 파일이 아닙니다.

같은 설명을 또 하게 되면 그때 한 줄 추가하시면 됩니다.

반대로 안 지켜지는 항목은 표현이 모호한 경우가 많습니다.

적어 뒀는데도 안 지켜집니다

"깔끔하게" 같은 말은 기준이 없어 지켜지지 않습니다.

"한 문단은 세 줄 이내" 처럼 셀 수 있게 적으셔야 합니다.

우선 빈 파일을 하나 만드십시오. 이름은 `CLAUDE.md` 입니다.

그리고 오늘 하루 같은 설명을 두 번 이상 한 것이 있는지 떠올려 보십시오.

그 문장을 그대로 적으시면 그게 첫 줄입니다.

완성해서 시작하려 하면 영영 못 만듭니다.

세 줄로 시작해서 필요할 때마다 늘리는 편이 훨씬 오래 갑니다.

며칠 써 보시면 어디가 비어 있는지 저절로 드러납니다.

저희 회사 자료를 어디까지 적어도 되나요

이 파일은 그 폴더 안에 있는 그냥 파일입니다. 공유 여부는 폴더 관리 방식에 따라 정하시면 됩니다.

매번 하는 설명이 곧 이 파일에 들어갈 내용입니다

#클로드코드 #CLAUDEmd #AI업무자동화 #개발도구 #프로젝트관리 아비컴퍼니 드림