릴리즈 노트란 무엇일까? 🤔
일상 속에서 릴리즈 노트와 가장 비슷한 노트를 찾을 수 있는 가장 쉬운 방법은 무엇일까요?
제가 생각한 방법은 바로 게임 업데이트(패치) 노트를 확인하는 것입니다.
어떠한 새로운 이벤트들이 추가 됐는지, 캐릭터의 밸런스 패치, 버그 수정 등 쉽게 보면 게임 업데이트 노트에서 가장 쉽게 볼 수 있는 것 같습니다.
릴리즈 노트 === 게임 패치 노트
릴리즈 노트와 게임 패치 노트가 같은 개념인지(?)는 정확하게 모르겠지만..!
위와 같이 생각하고 접근해봅시다!
릴리즈 노트란? 📖
- 소프트웨어 또는 서비스가 출시 또는 업데이트 될 때마다 해당 상품의 배포와 함께 변경 사항, 기능 추가/삭제, 버그 개선 등 변경 사항을 체계적으로 정리하여 정보를 제공하는 문서
- 릴리즈 노트는 정보 공유 뿐만 아니라 회사에 대한 긍정적인 인상을 심어주는 중요한 역할을 한다.
게임으로 대입해보면 새로운 캐릭터의 출시, 직업 버그 수정, 기존 사냥터 리뉴얼 등 여러가지 서비스의 변경 사항을 정리해서 보여줍니다.
이러한 릴리즈 노트를 보면 회사가 서비스를 개선하기 위해 열심히 노력하고 있다고 생각할 수 있습니다.
릴리즈 노트가 꼭 작성되어야 하는 이유 📚
- 업데이트 정보를 한 곳에 모아 기록함으로써, 내가 작업하지 않은 업데이트 사항도 빠르게 파악 가능
- 릴리즈 노트를 보면 누구나 제품의 발자취를 한 눈에 파악 가능
- 우리 회사의 제품 혹은 서비스가 지속적으로 개선되고 최신의 상태를 유지하고 있음을 안내
- 사용자의 신고와 의견을 반영하고 있다는 인상을 주어 사용자의 적극적인 피드백을 유도
구글 클라우드 서비스 팀의 릴리즈 노트를 보면 날짜를 기준으로 정리된 릴리즈 노트를 확인할 수 있습니다.
릴리즈 노트와 게임 패치 노트를 비교해보면 3, 4번은 오히려 게임 패치 노트에서 더 중요하다고 생각할 정도인데요.
1, 2번은 게임 패치 노트에서 한 눈에 파악하기는 조금 어려운 것 같습니다.
아무래도 패치 노트는 이미지의 추가, 긴 설명 등의 차이가 있기 때문이죠.
릴리즈 노트의 구성 요소 ⚙️
릴리즈 노트의 구성요소는 따로 정해져 있지는 않습니다.
회사나 조직마다 준수해야 하는 릴리즈 노트 표준은 존재하지 않는다.
그래서 제가 참고한 구글 클라우드, 카카오 테크, NHN 클라우드 등 여러 서비스의 릴리즈 노트 양식은 다 다릅니다.
하지만 일반적으로 릴리즈 노트는 버전, 날짜, 구분, 설명으로 구성됩니다.
버전
버전을 작성하지 않는 서비스들도 있습니다.
하지만 개인적으로 버전을 작성하는 것이 릴리즈 노트를 훨씬 효과적으로 확인할 수 있는 방법이라고 생각합니다.
독자들은 릴리즈 노트만 보고 신규 업데이트나 버그 픽스 등의 소프트웨어의 변경 범위를 대략적으로 유추할 수 있습니다.
날짜
영어식 표기 또는 국어식 표기 중 하나의 스타일을 정하고 전체 문서에서 일관된 스타일을 유지하는 것이 중요합니다.
구글을 포함한 여러 글로벌 IT 회사들은 스타일 가이드에 날짜 표기 방식에 대한 구체적인 정의를 포함하고 있습니다.
구분
해당 기능이 신규 추가 항목인지, 또는 수정 항목인지 변경 사항을 빠르게 파악할 수 있도록 도와줍니다.
태그(tag)의 역할을 하고 있습니다. 일반적으로는 New(최초), Feature(기능), Changed(변경), Fixed(수정), Deprecated(중단) 등의 항목이 포함될 수 있습니다.
해당 구분에 대한 내용도 본인이 속한 조직에서 자유롭게 정할 수 있습니다.
너무 다양하다면 해당 구분 태그를 관리하기 어렵고,너무 적으면 구분 태그로 표현하기가 어려울 것입니다.
설명
상품이나 서비스의 특성에 따라 릴리즈 노트의 설명 부분이 한 줄로 간략하게 끝날수도 있고, 자세하게 풀어쓰는 것도 가능합니다.
하지만 일반적으로 릴리즈 노트는 간략하고 집약적으로 작성하는 것이 일반적입니다.
그래서 자세하게 내용을 풀어서 쓰고 싶다면 관련 문서 링크를 연결하는 것도 좋습니다.
릴리즈 노트 작성 Tip 🙌
"버그 수정 및 성능 개선"은 지양
위의 문구를 반복적으로 사용하는 것은 지양해야 합니다.
적어도 어떤 버그가 개선되었는지, 어떤 기능이 어떻게 변경되거나 추가 되었는지 사용자가 파악할 수 있도록 작성하는 것이 좋습니다.
릴리즈 노트를 즐겨 읽고 개선된 기능을 빨리 사용해보고 싶어하는 독자들에게 알맞은 정보를 전달해주어야 합니다.
짧게 작성하고, 링크를 활용
제가 찾아봤을 때 이 부분은 상반된 의견을 보였는데요.
처음부터 간결하게 쓰려고 노력하면 꼭 들어가야 할 정보가 빠져 있거나, 모호한 노트를 쓰게 된다고 의견을 내는 사람이 있습니다.
반대로 가독성이 떨어지지 않게 최대한 간결하게 적는 것이 중요하다. 너무 길어지만 매뉴얼 본문을 보는 듯한 착각에 빠질 수 있다는 의견을 내는 사람도 있습니다. 그리고 자세한 안내를 원한다면 문서 페이지의 링크를 안내하는 것이 좋다고 말합니다.
사실 두 의견의 결과는 모두 짧게 작성하는 것입니다.
하지만 과정의 차이가 있을 뿐이죠. 본인이 훈련하고 싶은 방법으로 작성해보는 것이 어떨까요?
일관된 용어를 사용하라
릴리즈 노트를 작성하는 작성자마자 사용하는 용어가 다른 경우가 존재합니다.
BOT Response 기능 추가, Bot 응답 개선, 봇의 응답 방식 개선 등 같은 의미를 가지고 있지만 작성자가 사용하는 용어마다 전혀 다른식으로 표현이 됩니다.
이러한 경우 동일한 의미를 가진 여러 단어를 일관된 용어를 사용할 필요가 있습니다.
매우 사소해 보이지만, 매우 중요한 포인트라고 생각이 듭니다.
조직 내에서 작성자의 역할이 분명하거나, 모든 개발자가 작성에 참여할 경우에는 원활한 소통이 필요할 것입니다.
사용자 관점에서 쉽게 작성하라
릴리즈 노트는 독자를 위한 문서입니다.
그렇기 때문에 사용자가 주어라고 생각하고 글을 작성하는 것이 가독성을 높일 수 있습니다.
시각적 효과(그룹화)를 적용하라
사용자는 자신이 제보한 버그가 수정되었는지, 이번 버전에는 신규 기능이 있는지 등의 특정 목적을 가지고 릴리즈 노트를 읽습니다.
같은 내용이라도 색을 활용하여 구분을 나타내고 여백 또는 구분선 등을 활용하여 섹션을 구분하는 등 시각적 효과를 적용하면 릴리즈 노트의 가독성을 개선할 수 있습니다.
릴리즈 노트 작성하기
제가 사내 릴리즈 노트를 작성하면서 많이 참고했던 kakaoi의 릴리즈 노트입니다.
Bot 시작 가이드라는 서비스에 대한 릴리즈 노트를 가져 왔는데요.
해당 릴리즈 노트의 버전을 쭉 확인할 수 있습니다.
혹은 날짜를 기준으로 하위에 서비스명을 두고 릴리즈 노트를 작성해도 됩니다.
해당 릴리즈 노트는 google cloude service 릴리즈 노트입니다.
버전을 따로 존재하지 않고, 날짜를 기준으로 릴리즈 노트를 작성하고 있습니다.
두 릴리즈 노트 모두 설명은 길지 않게, 추가적인 설명은 텍스트에 링크를 붙여놓은 것을 볼 수 있습니다.
마무리
사내에서 사용할 릴리즈 노트를 작성하기 위해서 처음 릴리즈 노트를 찾아보고 정리해봤는데요.
릴리즈 노트의 경우에는 기존의 IT 기업들의 사례를 잘 조합해서 사용하는 것이 좋다고 생각합니다.
그래서 아예 처음부터 새로운 양식으로 만들어봐야겠다는 생각은 하지 않았던 것 같습니다.
출처에 첨부된 카카오 테크의 릴리즈 노트 작성법을 보시면 제가 정리한 내용보다 더 자세한 내용을 확인하실 수 있습니다.
