////
Search
Duplicate
2️⃣

2. 고객에게 유용한 정보를 쓰자

개발자 관점과 고객 관점

체인지 로그는 개발자가 변경한 내용을 적은 것이다. 즉 변경사항
외부 개발자나 일반 사용자가 보는 체인지 로그를 쓸 때는 개발자 관점이 아니라 고객 관점에서 쓰는 것이 좋다.
좋은 예시는 다음과 같다.
네이버 밴드 변경사항 채탕 답장 기능이 추가되었어요! 상대방 메시지를 꾹 눌러 답장쓰기를 해보세요. 밴드의 일정 참석 요청을 놓치지 않으려면, 가입 밴드의 일정 푸시 알림을 [참석확인과 미리알림 받기]로 설정해보세요
JavaScript
복사
변경사항 [멜론 v.4.8.4 업데이트] 검색: 새롭게 개편된 검색 홈에서는 주제별 검색 키워드를 한눈에 모아보고, 실시간 인기 검색어도 시간대별로 확인할 수 있습니다. OST, 방송, 키즈 캐릭터명을 검색하여 원하는 음악을 쉽게 찾고, 상황, 분위기, 장르명 검색을 통해 듣고 싶은 음악을 발견해보세요. 오픈 소스 라이브러리 업데이트를 통해 앱 안정성을 강화했습니다.
JavaScript
복사
이러한 관점은 정해져있는 것은 아니지만 보통 규격화는 되어 있다.

과거를 리뷰하고 미래를 보여주자

체인지 로그에는 '내가 한 일들'을 적는 것
다만, 고객이 요구하거나 불평한 것이 있다면 기약없이 기다림을 주지않기 위해 다음 릴리스 항목으로 검토하는 것이 있다면 중요한 것은 공개하는 것도 좋다.
// 카카오맵 2018년 5월 11월 체인지 로그 [주요 개선 항목] 지도 축소 상태에서 도로 굵기 개선, 지역 명칭 컬러 개선 국도, 지방도 컬러 구분 지하철 예정 노선 컬러 개선 등산로 선 두께 조절(524일 적용 예정) [검토 중인 항목] 건물 가독성 개선 검토 색각이상자 대응 검토 심볼 상세화 검토
JavaScript
복사

Semantic Versioning(유의적 버전)

체인지 로그는 버전 번호와 항상 같이 사용
버전 1.2.2 -> 1.2.3 / 간단한 패치를 의미, 이전 버전과 호환를 의미
버전 1.2.2 -> 1.3.0 / 새로운 기능을 추가했을 때
버전 1.2.2 -> 2.0.0 / 전면적인 업데이트이며 이전 버전과 거의 호환되지 않는다고 볼 수 있다
다만, 버전 번호를 올리는 단일 표준은 존재하지 않는다. 그냥,, 약속으로 정하자 팀 내, 혹은 따르자
유의적 버전에 대한 상세 내용은 다음과 같습니다.