[MD.SAVE]

AI & AGENT MARKDOWN GUIDE

좋은 컨텍스트는 좋은 답을 만듭니다.

LLM과 코딩 에이전트가 프로젝트를 빠르게 이해하도록 README, 작업 지침, 컨텍스트와 프롬프트를 역할별로 나누어 작성해 보세요.

어떤 파일을 선택해야 하나요?

README.md사람과 모든 개발 도구를 위한 보편적인 프로젝트 소개AGENTS.mdCodex와 호환 에이전트가 읽는 저장소 작업 지침CLAUDE.mdClaude Code가 세션마다 읽는 프로젝트 지침GEMINI.mdGemini CLI가 계층적으로 불러오는 컨텍스트.github/copilot-instructions.mdGitHub Copilot의 저장소 전역 사용자 지침AI_CONTEXT.md필요한 대화에 직접 첨부하는 일반 컨텍스트TASK_PROMPT.md반복 작업에서 직접 불러오는 일반 프롬프트

편집기에서 템플릿 바로 불러오기 →

README.md — 프로젝트의 입구

README는 프로젝트가 무엇인지, 왜 필요한지, 어떻게 실행하는지를 가장 먼저 설명합니다. 첫 문단에는 기술 목록보다 사용자가 얻는 결과를 적고, 실행 가능한 명령과 예상 결과를 가까이 배치하세요.

  • 한 문장 소개와 해결하는 문제
  • 설치·실행 명령과 필수 조건
  • 대표 사용 예시와 설정 방법
  • 프로젝트 구조, 기여 방법과 라이선스
# Project name

One sentence that explains the project.

## Quick start
## Usage
## Configuration
## Contributing

AGENTS.md — 작업 규칙과 경계

AGENTS.md는 호환되는 코딩 에이전트가 저장소에서 작업할 때 따라야 할 명령, 코드 규칙과 완료 조건을 모아두는 문서입니다. 추상적인 요청보다 실제 폴더 이름과 검증 명령을 적는 것이 좋습니다.

  • 저장소의 목적과 주요 디렉터리
  • 설치, 테스트, 린트와 빌드 명령
  • 수정하면 안 되는 생성 파일과 비밀값
  • 접근성·보안·문서화를 포함한 완료 조건
## Required commands

```bash
npm test
npm run lint
```

## Working rules

- Keep changes focused.
- Never expose secrets.
- Update tests with behavior.

OpenAI의 AGENTS.md 안내 ↗

CLAUDE.md — Claude Code 프로젝트 지침

Claude Code는 프로젝트 루트의 CLAUDE.md를 지속 지침으로 불러옵니다. 빌드 명령, 구조와 코딩 규칙처럼 대부분의 세션에 필요한 내용만 간결하게 유지하세요.

  • 프로젝트 목적과 주요 디렉터리
  • 반드시 실행할 개발·검증 명령
  • Claude Code가 반복해서 놓치는 규칙
  • AGENTS.md와 함께 쓸 때는 중복 최소화

Claude Code의 CLAUDE.md 공식 안내 ↗

GEMINI.md — Gemini CLI 컨텍스트

Gemini CLI는 GEMINI.md 파일을 찾아 프로젝트와 하위 디렉터리의 컨텍스트를 구성합니다. 공통 규칙은 루트에, 특정 영역의 규칙은 가까운 디렉터리에 두는 방식이 적합합니다.

  • 기술 구성과 저장소 안내
  • 개발 명령과 구현 원칙
  • 하위 영역에만 적용할 구체적인 컨텍스트
  • 완료 조건과 검증 방법

Gemini CLI의 GEMINI.md 공식 안내 ↗

.github/copilot-instructions.md — Copilot 저장소 지침

GitHub Copilot의 저장소 전역 지침은 짧고 독립적인 문장으로 작성하는 것이 좋습니다. 다운로드한 파일은 저장소의 .github/copilot-instructions.md 위치로 옮겨 사용하세요.

  • 사용하는 언어, 프레임워크와 패키지 관리자
  • 코드 스타일과 테스트 규칙
  • 보안상 금지할 데이터와 변경 범위
  • 모든 요청에 공통으로 적용할 내용만 포함

GitHub Copilot 사용자 지침 공식 안내 ↗

AI_CONTEXT.md — 직접 첨부하는 일반 배경

AI_CONTEXT.md는 특정 개발 도구가 자동 인식하는 표준 파일명이 아닙니다. 긴 대화 기록 대신 제품 목적, 현재 상태와 결정을 전달하고 싶을 때 직접 첨부하는 일반 문서로 사용하세요.

  • 제품과 대상 사용자를 한 문장으로 정의
  • 목표와 목표가 아닌 것을 함께 기록
  • 현재 상태와 알려진 문제를 날짜와 함께 갱신
  • 결정의 결과뿐 아니라 선택 이유도 보존

TASK_PROMPT.md — 직접 불러오는 반복 작업 명세

TASK_PROMPT.md 역시 자동 인식 표준 파일명은 아닙니다. 반복해서 사용하는 프롬프트를 직접 불러오기 쉽도록 역할, 목표, 입력, 제약, 출력 형식과 완료 점검을 분리해 저장하는 용도입니다.

  • 결과를 동사로 시작하는 한 문장 목표로 작성
  • 참고 자료와 지시사항을 분리
  • 추측하면 안 되는 항목과 확인 기준 명시
  • 원하는 결과 형식을 짧은 예시로 제공

민감한 정보는 넣지 마세요

API 키, 비밀번호, 실제 고객 데이터와 공개하면 안 되는 내부 주소는 템플릿에 기록하지 마세요. MD.SAVE는 작성 원문을 외부로 전송하지 않지만, 완성한 파일을 다른 서비스에 제공할 때는 해당 서비스의 저장·학습·보관 정책을 별도로 확인해야 합니다.