연구 방법 문서화은(는) 무엇을 하나요?
다른 연구자나 다른 에이전트가 방법을 생성한 대화에 접근하지 않고도 따라 할 수 있는 METHOD.md 파일 하나를 생성합니다.
단계
- 경계를 그립니다. 방법이 답하는 질문, 입력값, 출력값을 명시합니다. 대화에 여러 방법이 포함된 경우, 각 방법마다 별도의 파일을 작성합니다.
- 먼저 출처를 수집합니다. 누가 도출했는지(사람, 에이전트 또는 둘 다), 어떤 도구와 모델, 어떤 스킬 또는 프롬프트, 그리고 어떤 날짜인지. 추측하지 말고 누락된 정보는 요청하세요.
- 아래 템플릿을 사용하여
METHOD.md를 작성합니다. 대상 저장소에methods/_template/METHOD.md가 있는 경우, 더 최신일 수 있으므로 해당 템플릿을 대신 사용합니다. - 절차를 실행 가능하게 만듭니다. 번호가 매겨진 단계, 정확한 명령어 또는 방정식, 파라미터 기본값, 예상 실행 시간.
- 검증을 구체적으로 만듭니다. 방법이 작동함을 보여주는 테스트, 데이터셋 또는 새니티 체크를 명시하고, 실제로 관찰된 수치를 기록합니다.
- 제한 사항과 개발 중에 발견된 실패 모드를 기록합니다.
status를 정직하게 설정합니다. 검증이 결과를 관찰할 때까지draft, 검사가 통과되면validated, 논문에 인용되면published.
규칙
- 실제로 실행되거나 도출된 내용만 기록합니다. 테스트되지 않은 것은 untested로 표시합니다.
- 파일을 자체 완결적으로 유지합니다. 큰 코드 블록을 붙여넣기보다는 코드 링크를 추가합니다.
- 평이한 언어를 선호합니다. 독자가 해당 방법이 나온 프로젝트의 전문 용어를 모를 수 있습니다.
- 출처를 임의로 만들지 마세요. 모델이나 날짜를 모르는 경우
unknown으로 작성합니다.
템플릿
---
name: <폴더-이름>
description: <한 문장: 무엇을 하고 언제 사용하는지>
status: draft
origin: human | agent | mixed
agent: claude-code | codex | none
model: <모델 ID 또는 unknown>
skill: <사용된 SKILL.md 링크, 또는 비움>
derived: YYYY-MM-DD
---
# <방법 이름>
## 요약
## 문제
## 입력 및 출력
## 절차
## 검증
## 제한 사항 및 실패 모드
## 출처
## 사용처
## 참고 문헌