Release Note

* 이 글은 카카오엔터프라이즈의 Release Note 톺아보기를 보면서 정리한 글입니다.

 

1. 릴리즈 노트란?

릴리즈 노트란 소프트웨어 또는 서비스가 출시 또는 업데이트 될 때마다 해당 상품의 배포와 함께 변경 사항을 체계적으로 정리하여 정보를 제공하는 문서이다. 릴리즈 노트를 바탕으로 제품 혹은 서비스는 사용자의 피드백을 어떻게 반영하였고, 어떠한 기능이 추가되었는지에 대해 정보를 기록할 수 있다. 또한 이렇게 업데이트 된 내용을 내·외부적으로 공유해야 할 필요성이 제기되면서 많은 회사들이 릴리즈 노트를 작성하게 되었다.

2. 릴리즈 노트를 쓰면 좋은 점

✔️ 업데이트 된 점들을 빠르게 파악할 수 있다.

✔️ 제품의 발자취를 한눈에 파악할 수 있다.

✔️ 제품 혹은 서비스가 최신 상태를 유지하는 지 알 수 있다.

✔️ 사용자의 의견을 반영한다는 인상을 주어, 사용자의 적극적인 피드백을 유도할 수 있다.

 

3. 릴리즈 노트의 구성 요소

1️⃣ 버전

v.x.y.z의 형태로 시작하며 v뒤는 숫자로 이루어져있다. 각 숫자는 메이저 버전, 마이너 버전, 패치 버전이라 불린다. 

메이저 버전은 상품 또는 서비스 버전으로 신규 버전(v.1.0.0)또는 이전 버전과 호환되지 않을 정도로 매우 큰 변화가 발생한 경우를 의미한다.

마이너 버전은 이전 버전과 호환 가능한 상태에서 신규 기능의 추가, 기존 기능이 삭제된 경우를 의미한다.

패치 버전은 API를 변경하지 않은 사소한 변경이나 버그 수정 등을 의미한다.

 

주절주절의 버전 관리 방법

현재 우리의 프로젝트에서는 정식 버전이 아님을 알리기 위해서 버전 뒤에 -beta를 붙여서 사용하고 있다. 또한 각각의 버전의 업데이트 또한 사용자의 입장에서 생각하기로 했다.

 

✔️ 메이저 버전(주버전)은 기존 버전과 호환되지 않은 경우를 의미하는데, 사용자의 입장에서 기획이 바뀌었을 때를 의미한다.

새로운 기능이 추가되면 뭔가 주버전을 업데이트 하고싶지만, 사용자 입장에서 단순히 '바뀌었다'라는 생각이 들지 않고 기능이 '추가되었다'라고 인지가 되면 주버전의 경우 업데이트가 거의 일어나지 않는다.

✔️ 마이너 버전은 기존 버전과 호환되면서 새로운 기능이 추가되었을 때를 의미한다.

✔️ 패치 버전은 기존버전과 호환되면서, 버그 수정 특히 핫픽스가 되었을 때를 의미한다.

2️⃣ 날짜

릴리즈 노트에는 버전 출시나 문서 업데이트에 따른 날짜 정보가 포함되며, 날짜는 해당 문서가 얼마나 최신인지를 보여주는 역할을 한다.

날짜를 표기하는 방식은 영어식 표기나 국어식 표기 중 하나의 스타일 정해서 일관된 표기 방식을 유지하는 것이 중요하다.

 

 주절주절의 날짜 관리 방법

년, 월, 일을 숫자로 표기한다.

3️⃣ 구분

구분은 사용자들에게 해당 기능이 신규 추가 항목인지, 수정된 내용인지를 알려주어 변경사항을 빠르게 파악할 수 있는 Tag 역할을 한다.일반적으로 New(최초), Feature(기능), Changed(변경), Fixed(수정), Deprecated(중단) 등의 항목이 포함된다.

 

카카오 i 기술문서

4️⃣ 설명

소프트웨어의 변경사항을 기술하는 부분이다. 간략하게 한줄로 끝날 수도 있고, 자세하게 풀어쓰는 것도 가능하다. 하지만 릴리즈 노트는 한눈에 파악할 수 있도록 집약적으로 작성하는 것이 일반적이기때문에 변경 사항에 대해서 자세히 안내하고 싶다면 관련 문서 링크를 연결하는 것이 좋다. 또한 관련 시연 영상을 가지고 있는 링크를 연결하는 것도 좋은 방법이다.

 

✔️ 한눈에 알아보기 쉽게 쓰자

릴리즈 노트를 상세하게 적을 필요는 없다. 하지만 "버그 수정 및 성능 개선"과 같이 포괄적인 말보다는 어떤 버그가 수정되었고 어떤 기능이 어떻게 변경되거나 추가되었는지 사용자가 파악할 수 있도록 작성하는 것이 좋다.

✔️ 간결한 문장과 링크를 활용하자

릴리즈 노트를 최대한 간결하게 적는 것이 좋다. 두 줄 이상 넘어가게 되면, 릴리즈 노트가 아닌 메뉴얼을 보는 듯한 착각을 줄 수 있다. 

릴리즈 노트의 목적은 간결하고 집약적으로 해당 서비스의 변경 사항을 보여주는 것이다.

✔️ 일관된 용어를 사용하자

일관되지 않은 용어를 사용할 경우, 사용자에게 동일 기능인지 아닌지를 파악하는데 혼란을 줄 수 있다.

✔️ 사용자의 관점에서 쉽게 작성하자

릴리즈 노트는 사용자(독자)를 위한 문서이기 때문에 사용자 관점에서 작성해야 하며, 사용자가 어떠한 부분에서 변경이 이뤄졌는지 쉽게 파악할 수 있어야 한다. 예를들어 상세설명 추가 라고 쓰는 것보다, 제품 상세 페이지에 제품에 대한 설명 추가라고 쓰는 것이 훨씬 가독성을 높이는 방법이다.

✔️ 시각적 효과를 적용하라

날짜, 구분 등을 사용자가 쉽게 파악할 수 있도록 색을 활용할 수 있다. 또한 구분선이나 여백을 통해서 섹션을 구분하면 가독성을 개선할 수 있다.