구조 원칙
- 문서 하나의 목적을 첫 문단에 적고 H1은 하나만 사용합니다.
- H2와 H3로 주제를 나누되 제목 단계를 건너뛰지 않습니다.
- 규칙, 사실, 예시와 예외를 서로 다른 섹션이나 목록으로 분리합니다.
- 모호한 “위 내용” 대신 파일명, 경로, 명령과 대상을 직접 적습니다.
코드와 데이터
- 코드는 fenced code block에 넣고 언어를 표시합니다.
- 표는 비교에만 사용하고 긴 설명은 제목과 목록으로 나눕니다.
- 링크 텍스트에 출처의 의미를 적고 날짜에 민감한 사실은 기준 시점을 표시합니다.
- 지시 문서에는 적용 범위, 금지 사항, 검증 명령과 완료 조건을 포함합니다.
문맥의 시작과 끝을 직접 적으세요
문서가 어느 저장소·제품·버전에 적용되는지 첫 부분에 적고, 추측하면 안 되는 영역과 확인할 기준 소스를 구분합니다. RAG나 파일 첨부에서 문서 한 개만 잘려 들어가도 `현재`, `그 파일`, `위 규칙` 같은 표현이 무엇을 뜻하는지 알 수 있어야 합니다.
좋은 예시는 결과와 예외를 함께 보여줍니다
- 명령만 적지 말고 성공할 때 생성되는 파일이나 출력도 적습니다.
- 예외 입력과 실패 시 중단해야 하는 조건을 분리합니다.
- 날짜에 민감한 값은 확인일과 기준 문서 링크를 함께 둡니다.
- 비밀값과 개인정보는 예시에서도 실제 값을 사용하지 않습니다.
마지막 확인
MD.SAVE의 문서 개요와 로컬 점검으로 제목 흐름, 문서 내 링크, 이미지 설명, HTML과 닫히지 않은 코드 블록을 확인하세요.