AI와 사람을 위한 마크다운 지시문 작성 가이드
이 문서는 AI와 사람이 모두 이해하기 쉬운 프롬프트 지시문을 마크다운(.md) 파일로 작성하는 방법에 대한 포괄적인 가이드라인을 제공합니다. 명확성, 일관성, 구조화를 핵심 원칙으로 삼습니다.
프롬프트 문서화의 중요성
- 지식 보존: 중요한 프롬프트 관련 지식의 유실을 방지합니다.
- 중복 방지: 팀 내 중복 프롬프트 생성을 막아 효율성을 높입니다.
- 정보 공유: 부서 간 정보 사일로(silo)를 허물고 원활한 지식 공유를 돕습니다.
- 규정 준수: 관리되지 않는 프롬프트가 조직의 규정을 위반하는 것을 방지합니다.
핵심 가이드라인
1. 파일 및 폴더 구조
- 프롬프트는 중앙 저장소(Repository)에서 관리합니다.
templates,use-cases,components,examples와 같이 기능별로 폴더를 구조화하여 명확하게 관리합니다.
2. 마크다운 서식 표준
- 제목(Heading): 문서 당 하나의 최상위 제목(
#)을 사용하고,##,###순으로 논리적인 계층을 유지합니다. - 서식: 중요한 내용은 굵게, 강조는 기울임꼴을 사용하는 등 서식을 일관되게 적용합니다.
3. 프롬프트 문서 템플릿
일관된 문서화를 위해 표준 템플릿 사용을 권장하며, 다음 요소를 포함합니다.
- 목적 (Purpose): 프롬프트의 역할과 사용 시점.
- 매개변수 (Parameters): 입력 값의 이름, 타입, 필수 여부, 설명을 담은 표.
- 템플릿 (Template): 실제 프롬프트 내용.
{{변수}}를 사용해 동적 입력을 처리. - 설정 (Configuration): 모델(gpt-4o 등), 온도(temperature) 등 실행 환경 설정.
- 입력/출력 예시: 실제 사용 예시와 기대 결과.
- 노트 (Notes): 주의사항이나 모범 사례.
- 버전 기록 (Version History): 변경 이력을 추적하는 표.
4. YAML 머리말 (Front Matter) 활용
문서의 메타데이터(제목, 작성자, 버전, 태그 등)를 YAML 형식으로 파일 상단에 명시하여 구조화된 관리를 돕습니다.
---
title: Product Feature Summarizer
author: Alex Wong
version: 1.1
date: 2025-04-30
model: gpt-4o
temperature: 0.7
description: Creates concise summaries of product features.
tags: [marketing, summarization]
---5. 버전 관리 및 유지보수
- Git과 같은 버전 관리 시스템을 사용하여 변경 사항을 추적합니다.
- 정기적으로 문서를 검토하여 정확성과 품질을 유지합니다.
원본 Gist
- Best Practice Guidelines for Prompt Markdown Instructions: https://gist.github.com/eonist/bf948cea1af1463732e2f5528a49572b (opens in a new tab)