Sift 0.5 베타의 변경 기록을 쓰면서 형용사를 모두 지웠습니다. "더 빨라졌습니다" 대신 무엇이 몇 초에서 몇 초가 되었는지 적었습니다.
무엇이 바뀌었는지부터 쓰기#
“사용성이 개선되었습니다”라고 적어 두면 다음 버전에도 같은 문장을 쓸 수 있습니다. 누가 어떤 동작을 할 때 달라지는지 써야 변경 기록이 서로 구분됩니다.
좌우로 이동해 나머지 열 보기
| 초안 | 남긴 문장 |
|---|---|
| 검색 성능을 개선했습니다. | 시간 범위를 지정하면 해당 구간의 시작 위치부터 읽습니다. |
| 오류 처리를 강화했습니다. | 읽지 못한 파일의 경로와 이유를 결과 끝에 표시합니다. |
| 편리한 새 옵션을 추가했습니다. | --until로 로그 읽기를 끝낼 시각을 지정할 수 있습니다. |
이유와 사용자가 할 일을 이어 적기#
바뀐 동작
어떤 입력에서 결과가 달라지는지 적습니다.
바꾼 이유
기존 동작의 불편이나 오류를 한 문장으로 연결합니다.
필요한 행동
명령이나 설정을 바꿔야 한다면 예를 함께 적습니다.
속도를 적을 때는 파일 크기와 비교 조건을 남깁니다. 아직 수치가 없다면 “더 빠르다”는 문장을 빼고 달라진 동작만 설명합니다. 짧아진 기록은 버전 사이의 차이를 찾기에도 편했습니다.
Sift의 시간 범위 구현 메모에는 변경 이유와 측정 조건을 이어 적었습니다.
댓글
불러오는 중…