06. 결정과 학습 남기기
다음 작업자가 대화 기록 없이도 변경 이유와 검증 방법을 이해하고 이어갈 수 있는 최소 기록을 만듭니다.
핵심 설명
섹션 제목: “핵심 설명”모든 대화와 실행 로그를 저장할 필요는 없습니다. 오래 유지되어야 할 사실만 적절한 위치에 남깁니다. 저장소 전체에 적용되는 규칙은 저장소 지침에, 제품의 공식 정의는 권위 있는 제품 문서에, 한 작업의 구현 근거는 커밋이나 변경 설명에, 반복 운영 절차는 runbook에 둡니다.
좋은 기록은 “무엇을 했는가”뿐 아니라 “왜 이 범위를 선택했는가”, “무엇으로 확인했는가”, “무엇이 남았는가”를 포함합니다. 임시 추정은 사실처럼 승격하지 않습니다. 실제 비밀값, 사용자 데이터, 불필요한 전체 프롬프트와 장황한 실행 로그는 기록하지 않습니다.
상황: 어떤 선택이 필요했는가
결정: 무엇을 선택했는가
이유: 어떤 근거가 있었는가
제외: 무엇을 이번에 하지 않았는가
영향: 이후 작업에서 알아야 할 것은 무엇인가
체크리스트
섹션 제목: “체크리스트”- 공식 사실과 작업별 메모의 저장 위치를 구분했습니다.
- 공개 카피나 정책을 바꿨다면 권위 있는 원문을 함께 검토했습니다.
- 변경 이유와 검증 방법이 기록되어 있습니다.
- 임시 가정과 확정된 결정을 구분했습니다.
- 다음 사람이 해야 할 일과 남은 위험이 보입니다.
- 비밀값과 실제 사용자 데이터가 기록에 없습니다.
- 재사용 가치가 없는 대화 전문을 문서로 옮기지 않았습니다.
직접 해보기
섹션 제목: “직접 해보기”이번 작업에서 판단이 필요했던 선택 하나를 위 형식으로 정리합니다. 이어서 인수인계 메모를 작성합니다.
결과:
주요 변경 위치:
실행한 검증:
남은 위험 또는 미결정:
다음 행동:
처음 보는 동료가 저장소와 이 메모만으로 검증을 다시 실행할 수 있는지 확인합니다.
완료 근거
섹션 제목: “완료 근거”- 변경 이유와 검증 방법을 대화 기록 없이 설명할 수 있습니다.
- 공식 문서와 파생 화면 사이의 불일치가 없습니다.
- 다음 작업자가 실행할 명령과 확인할 위험을 찾을 수 있습니다.
- 기록에 민감한 정보가 없습니다.
다음은 코드 완료와 릴리스를 구분하는 07. 배포하고 운영하기입니다.