모든 가이드 보기

AI 작업 문서

README와 작업 지시 파일을 한 묶음으로 관리하기

같은 명령을 여러 파일에 복사해 두면 한 곳만 고친 뒤 내용이 어긋납니다. MD.SAVE에서 각 파일의 제목 구조를 나란히 확인하며 README는 처음 온 사람에게, AGENTS는 저장소에서 일하는 도구에게 답하도록 나누세요.

완료할 작업사람용 설명과 에이전트 실행 규칙이 충돌하지 않는 문서 구조
01

README.md는 처음 온 사람에게 답합니다

README의 첫 독자는 저장소를 처음 연 사람입니다. 무엇을 만드는지, 설치와 실행은 어떻게 하는지, 어디에서 더 읽어야 하는지를 설명합니다. 특정 코딩 에이전트의 행동 규칙은 README 본문을 흐리게 만들 수 있습니다.

  • 제품 또는 라이브러리의 목적
  • 지원 환경과 가장 짧은 실행 예시
  • 주요 디렉터리와 문서 링크
  • 라이선스와 문의 경로
02

AGENTS.md는 저장소에서 일하는 방법을 정합니다

AGENTS.md에는 실행 가능한 명령, 수정 범위, 금지 사항과 완료 조건을 적습니다. ‘꼼꼼히 테스트’보다 ‘npm test와 npm run lint를 실행’처럼 결과를 확인할 수 있는 문장이 낫습니다.

좋은 규칙의 형태번역 문구는 content/에서 한국어와 영어를 함께 수정한다.배포 전 npm test와 npm run lint를 통과한다.운영 비밀값과 .openai/hosting.json을 다른 서비스로 복사하지 않는다.
03

CLAUDE.md와 GEMINI.md는 도구별 차이만 둡니다

공통 규칙을 다시 복사하기보다 AGENTS.md를 기준 문서로 가리키고, 해당 도구에서만 필요한 명령이나 제한을 추가합니다. 도구별 파일이 없어도 작업 가능한 구조가 유지보수하기 쉽습니다.

04

하위 폴더 규칙은 가까운 곳에 둡니다

웹사이트와 확장 프로그램의 검증 명령이 다르면 저장소 루트에 모든 경우를 길게 나열하기보다 해당 하위 폴더에 작은 AGENTS.md를 둡니다. 적용 범위를 경로로 확인할 수 있어 충돌이 줄어듭니다.

05

중복을 찾는 마지막 점검

  • 같은 명령이 세 파일에 복사되어 있지 않은가
  • 현재 존재하지 않는 경로나 패키지 이름이 남지 않았는가
  • 금지 사항에 이유와 적용 범위가 있는가
  • 완료 조건이 실제 테스트와 배포 절차를 덮는가