콘텐츠로 이동

13. 규칙 한 장 요약

핵심: 규칙은 많아 보이지만, 모두 **"그림과 기록이 언제나 일치해서, 누가 물어도 근거를 보여 줄 수 있게"**라는 하나의 목적에서 나옵니다. 전체 규칙은 AGENTS.md에 있고, 사람과 AI가 같은 규칙을 따릅니다. 설계 이유는 설계 결정 기록에 있습니다.

# 규칙 왜 지키는 장치
1 원본 데이터는 읽기만 합니다. 이름 줄이기·범위 자르기는 설정으로 합니다. 그림이 어떤 데이터에서 왔는지 언제든 증명하기 위해 (3장) 출처 기록의 지문, 원본이 바뀌면 "낡음" 표시
2 그림의 모든 값은 설정 파일에, 설명 주석과 함께 둡니다. 코드에 숫자를 박지 않습니다. 프로그램을 몰라도 설정만 보고 그림을 이해하고 고치기 위해 (6장) 번들을 붙일 때 전체 값 자동 기록, 코드 속 숫자 검사
3 결과 폴더의 파일을 손으로 고치지 않습니다. 고칠 것은 설정이나 그림 설명에서 고칩니다. 다음 빌드에서 사라지고, 그림과 기록이 어긋나기 때문에 (7장) 매 빌드가 결과를 새로 만듦
4 그림은 인쇄 크기 그대로 그리고, 인쇄 전 검사 오류를 0으로 만든 뒤 완성이라고 합니다. 교정쇄에서야 문제를 발견하지 않기 위해 (8장) 인쇄 전 검사, 투고 전 엄격 모드
5 설명 속 결과 숫자는 데이터에서 채웁니다. 별표는 설정한 검정으로 계산하고 검정표를 남깁니다. 데이터가 바뀌어도 그림·설명·본문이 어긋나지 않기 위해 (9장) 값 없는 자리 → 검증 실패, 손 숫자 증가 → CI 차단, 검정표 없음 → 검증 실패
6 이미지는 원본을 넣고, 조정은 그림을 그릴 때 설정으로 합니다. 비선형 조정은 그림 설명에 밝힙니다. 저널의 이미지 무결성 규정에 기록으로 답하기 위해 (9장) 조정 내역 자동 기록, 원본 변경 → 검증 실패
7 Figure 번호와 논문 프로젝트 이름을 1:1로 맞추고, 스토리라인을 바꿀 때마다 개편 기록을 남깁니다. 그림은 지우지 않고 보관합니다. 석 달 뒤에도 "그때 무엇을 왜 바꿨나"에 답하기 위해 (11장) 스토리라인 검사, 대응표 자동 생성, 보관 후 재빌드 확인

이름과 위치 (참고)

무엇 위치와 이름
설정 파일 configs/연구단위/단계/config_프로젝트이름.yaml
분석 파일 analysis/연구단위/단계/프로젝트이름_analysis.py
그림 설명 파일 figure_specs/연구단위/단계/figure_01_프로젝트이름.py
단계 exploratory (탐색), paper (논문), archive (보관)
논문 프로젝트 이름 연구단위-paper-main-fig번호-짧은이름 (보충 그림은 supp)
원본 데이터 raw_data/연구이름/프로젝트이름/번들이름/

이름과 위치는 프로젝트 만들기·승격·은퇴 명령이 알아서 맞춥니다. 직접 기억할 필요는 없지만, 파일을 찾을 때 참고하세요.


이전: 12. AI와 함께 일하기 · 다음: 부록 A. 용어집