작은 API의 입력 조건 문서화 — 연말 기록의 보관 기준의 둘이 함께 보는 변경 기록
두 명의 작업자가 같은 프로젝트를 번갈아 수정하는 상황을 살펴봅니다. 여기에 한 해의 자료를 닫고 다음 작업에 필요한 것만 꺼내두는 장면을 더합니다. 필수 필드와 허용 형식, 오류 조건을 먼저 적습니다. 수정한 이유와 확인한 범위를 기록해 다음 사람이 추측하지 않게 합니다.
1
장면과 준비 조건
두 명의 작업자가 같은 프로젝트를 번갈아 수정하는 상황을 살펴봅니다. 삭제와 보관을 구분하고 다시 찾을 수 있는 위치를 적습니다
2
작은 범위에서 확인
필수 필드와 허용 형식, 오류 조건을 먼저 적습니다. 수정한 이유와 확인한 범위를 기록해 다음 사람이 추측하지 않게 합니다
3
결과를 다음 행동으로
프런트엔드와 서버의 검증 조건이 일치하는지 확인하고, 남은 질문과 다시 살펴볼 조건을 한곳에 기록합니다.
점검할 환경과 입력
두 명의 작업자가 같은 프로젝트를 번갈아 수정하는 상황을 살펴봅니다. 여기에 한 해의 자료를 닫고 다음 작업에 필요한 것만 꺼내두는 장면을 더합니다. 필수 필드와 허용 형식, 오류 조건을 먼저 적습니다. 수정한 이유와 확인한 범위를 기록해 다음 사람이 추측하지 않게 합니다.
- 장면을 좁히기: 삭제와 보관을 구분하고 다시 찾을 수 있는 위치를 적습니다
- 작게 실행하기: 필수 필드와 허용 형식, 오류 조건을 먼저 적습니다.
- 확인하고 남기기: 프런트엔드와 서버의 검증 조건이 일치하는지 살펴보고 다음에 다시 볼 위치를 적습니다.
재현 결과를 남기는 기준
둘이 함께 보는 변경 기록 상황에서는 프런트엔드와 서버의 검증 조건이 일치하는지 확인하는 과정이 필요합니다. 삭제와 보관을 구분하고 다시 찾을 수 있는 위치를 적습니다 그 뒤 수정한 이유와 확인한 범위를 기록해 다음 사람이 추측하지 않게 합니다 이 순서로 살펴봤을 때 불편이 남는다면 필요한 준비가 빠졌는지, 예상한 사용 장면과 실제 적용 조건이 다른지 나누어 봅니다.